Class Client

Hierarchy

Client

Index

Constructors

Properties

Methods

isExpired post setAuth setDefaultErrorHandler validateAndSetAuth

Constructors

constructor

new Client(clientFactory: ClientFactory, settings: ClientFactorySettings): Client
Parameters
- clientFactory: ClientFactory
- settings: ClientFactorySettings
Returns Client
- Defined in BackplaneJsClient/jsclient.d.ts:94

Properties

`Readonly` status

status: "closed" | "new" | "open"

Methods

isExpired

isExpired(auth: AuthToken): boolean
Parameters
- auth: AuthToken
Returns boolean
- Defined in BackplaneJsClient/jsclient.d.ts:96

post

post(projectName: string, taskName: string, input?: unknown, auth?: AuthToken): Task
Parameters
- projectName: string
- taskName: string
- Optional input: unknown
- Optional auth: AuthToken
Returns Task
- Defined in BackplaneJsClient/jsclient.d.ts:99
post(projectName: string, input?: unknown, auth?: AuthToken): Task
Parameters
- projectName: string
- Optional input: unknown
- Optional auth: AuthToken
Returns Task
- Defined in BackplaneJsClient/jsclient.d.ts:100
post(projectName: string, taskName: string, input?: unknown, auth?: AuthToken): Task
Parameters
- projectName: string
- taskName: string
- Optional input: unknown
- Optional auth: AuthToken
Returns Task
- Defined in BackplaneJsClient/jsclient.d.ts:101

setAuth

setAuth(auth: AuthToken): Promise<void>
Parameters
- auth: AuthToken
Returns Promise<void>
- Defined in BackplaneJsClient/jsclient.d.ts:97

setDefaultErrorHandler

setDefaultErrorHandler(defaultErrorHandler: ((error: Error, request: unknown, response: unknown) => void)): void
Parameters
- defaultErrorHandler: ((error: Error, request: unknown, response: unknown) => void)
  - - (error: Error, request: unknown, response: unknown): void
    - Parameters
      
      error: Error
      
      request: unknown
      
      response: unknown
      
      Returns void
Returns void
- Defined in BackplaneJsClient/jsclient.d.ts:95

validateAndSetAuth

validateAndSetAuth(auth: AuthToken): Promise<void>
Parameters
- auth: AuthToken
Returns Promise<void>
- Defined in BackplaneJsClient/jsclient.d.ts:98

Generated using TypeDoc