Class ClientBuilder

Constructors

constructor

new ClientBuilder(): ClientBuilder
Returns ClientBuilder
- Defined in client/builder.ts:57

Properties

`Private` authMiddleware

authMiddleware: Middleware

`Private` concurrentMiddleware

concurrentMiddleware: Middleware

`Private` correlationIdMiddleware

correlationIdMiddleware: Middleware

`Private` errorMiddleware

errorMiddleware: Middleware

`Private` httpMiddleware

httpMiddleware: Middleware

`Private` loggerMiddleware

loggerMiddleware: Middleware

`Private` middlewares

middlewares: Middleware[] = []

`Private` projectKey

projectKey: string

`Private` queueMiddleware

queueMiddleware: Middleware

`Private` userAgentMiddleware

userAgentMiddleware: Middleware

Methods

build

build(): Client
Returns Client
- Defined in client/builder.ts:246

defaultClient

defaultClient(baseUri, credentials, oauthUri?, projectKey?, scopes?, httpClient?): ClientBuilder
Parameters
- baseUri: string
- credentials: Credentials
- Optional oauthUri: string
- Optional projectKey: string
- Optional scopes: string[]
- Optional httpClient: Function
Returns ClientBuilder
- Defined in client/builder.ts:66

withAnonymousSessionFlow

withAnonymousSessionFlow(options): ClientBuilder
Parameters
- options: AuthMiddlewareOptions
Returns ClientBuilder
- Defined in client/builder.ts:135

`Private` withAuthMiddleware

withAuthMiddleware(authMiddleware): ClientBuilder
Parameters
- authMiddleware: Middleware
Returns ClientBuilder
- Defined in client/builder.ts:85

withClientCredentialsFlow

withClientCredentialsFlow(options): ClientBuilder
Parameters
- options: AuthMiddlewareOptions
Returns ClientBuilder
- Defined in client/builder.ts:95

withConcurrentModificationMiddleware

withConcurrentModificationMiddleware(customLogic?): ClientBuilder
Parameters
- Optional customLogic: ((version, request, response) => Promise<string | Record<string, any> | Buffer>)
  - - (version, request, response): Promise<string | Record<string, any> | Buffer>
    - Parameters
      version: number
      request: ClientRequest
      response: MiddlewareResponse
      Returns Promise<string | Record<string, any> | Buffer>
Returns ClientBuilder
- Defined in client/builder.ts:227

withCorrelationIdMiddleware

withCorrelationIdMiddleware(options?): ClientBuilder
Parameters
- Optional options: CorrelationIdMiddlewareOptions
Returns ClientBuilder
- Defined in client/builder.ts:216

withErrorMiddleware

withErrorMiddleware(options?): ClientBuilder
Parameters
- Optional options: ErrorMiddlewareOptions
Returns ClientBuilder
- Defined in client/builder.ts:240

withExistingTokenFlow

withExistingTokenFlow(authorization, options?): ClientBuilder
Parameters
- authorization: string
- Optional options: ExistingTokenMiddlewareOptions
Returns ClientBuilder
- Defined in client/builder.ts:171

withHttpMiddleware

withHttpMiddleware(options): ClientBuilder
Parameters
- options: HttpMiddlewareOptions
Returns ClientBuilder
- Defined in client/builder.ts:183

withLoggerMiddleware

withLoggerMiddleware(options?): ClientBuilder
Parameters
- Optional options: LoggerMiddlewareOptions
Returns ClientBuilder
- Defined in client/builder.ts:210

withMiddleware

withMiddleware(middleware): ClientBuilder
Parameters
- middleware: Middleware
Returns ClientBuilder
- Defined in client/builder.ts:90

withPasswordFlow

withPasswordFlow(options): ClientBuilder
Parameters
- options: PasswordAuthMiddlewareOptions
Returns ClientBuilder
- Defined in client/builder.ts:114

withProjectKey

withProjectKey(key): ClientBuilder
Parameters
- key: string
Returns ClientBuilder
- Defined in client/builder.ts:61

withQueueMiddleware

withQueueMiddleware(options?): ClientBuilder
Parameters
- Optional options: QueueMiddlewareOptions
Returns ClientBuilder
- Defined in client/builder.ts:201

withRefreshTokenFlow

withRefreshTokenFlow(options): ClientBuilder
Parameters
- options: RefreshAuthMiddlewareOptions
Returns ClientBuilder
- Defined in client/builder.ts:153

withUserAgentMiddleware

withUserAgentMiddleware(options?): ClientBuilder
Parameters
- Optional options: HttpUserAgentOptions
Returns ClientBuilder
- Defined in client/builder.ts:193