Class BaseClient

Hierarchy (View Summary)

BaseClient
- ConfluenceClient

Implements

Client

Index

Constructors

constructor

new BaseClient(
    config: {
        apiPrefix?: string;
        authentication?:
            | { basic: { apiToken: string; email: string } }
            | { jwt: { expiryTimeSeconds?: number; issuer: string; secret: string } }
            | { oauth2: { accessToken: string } };
        baseRequestConfig?: any;
        host: string;
        middlewares?: {
            onError?: (...args: [any, ...unknown[]]) => void;
            onResponse?: (...args: [any, ...unknown[]]) => void;
        };
        noCheckAtlassianToken?: boolean;
    },
): BaseClient
Parameters
- config: {
      apiPrefix?: string;
      authentication?:
          | { basic: { apiToken: string; email: string } }
          | { jwt: { expiryTimeSeconds?: number; issuer: string; secret: string } }
          | { oauth2: { accessToken: string } };
      baseRequestConfig?: any;
      host: string;
      middlewares?: {
          onError?: (...args: [any, ...unknown[]]) => void;
          onResponse?: (...args: [any, ...unknown[]]) => void;
      };
      noCheckAtlassianToken?: boolean;
  }
  - OptionalapiPrefix?: string
    Prefix for all API routes.
  - Optionalauthentication?:
        | { basic: { apiToken: string; email: string } }
        | { jwt: { expiryTimeSeconds?: number; issuer: string; secret: string } }
        | { oauth2: { accessToken: string } }
  - OptionalbaseRequestConfig?: any
  - host: string
  - Optionalmiddlewares?: {
    onError?: (...args: [any, ...unknown[]]) => void;
    onResponse?: (...args: [any, ...unknown[]]) => void;
    }
    OptionalonError?: (...args: [any, ...unknown[]]) => void
    Error handler middleware
    
    OptionalonResponse?: (...args: [any, ...unknown[]]) => void
    Response handler middleware
  - OptionalnoCheckAtlassianToken?: boolean
    Adds 'X-Atlassian-Token': 'no-check' to each request header
Returns BaseClient
- Defined in src/clients/baseClient.ts:21

Properties

`Protected` `Readonly`config

config: {
    apiPrefix?: string;
    authentication?:
        | { basic: { apiToken: string; email: string } }
        | { jwt: { expiryTimeSeconds?: number; issuer: string; secret: string } }
        | { oauth2: { accessToken: string } };
    baseRequestConfig?: any;
    host: string;
    middlewares?: {
        onError?: (...args: [any, ...unknown[]]) => void;
        onResponse?: (...args: [any, ...unknown[]]) => void;
    };
    noCheckAtlassianToken?: boolean;
}

Type declaration

OptionalapiPrefix?: string
Prefix for all API routes.
Optionalauthentication?:
    | { basic: { apiToken: string; email: string } }
    | { jwt: { expiryTimeSeconds?: number; issuer: string; secret: string } }
    | { oauth2: { accessToken: string } }
OptionalbaseRequestConfig?: any
host: string
Optionalmiddlewares?: {
onError?: (...args: [any, ...unknown[]]) => void;
onResponse?: (...args: [any, ...unknown[]]) => void;
}
- OptionalonError?: (...args: [any, ...unknown[]]) => void
  Error handler middleware
- OptionalonResponse?: (...args: [any, ...unknown[]]) => void
  Response handler middleware
OptionalnoCheckAtlassianToken?: boolean
Adds 'X-Atlassian-Token': 'no-check' to each request header

Methods

`Protected`encode

encode(value: string): string
Parameters
- value: string
Returns string
- Defined in src/clients/baseClient.ts:63

`Protected`paramSerializer

paramSerializer(parameters: Record<string, any>): string
Parameters
- parameters: Record<string, any>
Returns string
- Defined in src/clients/baseClient.ts:35

`Protected`removeUndefinedProperties

removeUndefinedProperties(obj: Record<string, any>): Record<string, any>
Parameters
- obj: Record<string, any>
Returns Record<string, any>
- Defined in src/clients/baseClient.ts:73

sendRequest

sendRequest<T>(requestConfig: RequestConfig, callback: never): Promise<T>
Type Parameters
- T
Parameters
- requestConfig: RequestConfig
- callback: never
Returns Promise<T>
Implementation of Client.sendRequest
- Defined in src/clients/baseClient.ts:99
sendRequest<T>(
requestConfig: RequestConfig,
callback: Callback<T>,
): Promise<void>
Type Parameters
- T
Parameters
- requestConfig: RequestConfig
- callback: Callback<T>
Returns Promise<void>
Implementation of Client.sendRequest
- Defined in src/clients/baseClient.ts:100

Class BaseClient

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

OptionalapiPrefix?: string

Optionalauthentication?: | { basic: { apiToken: string; email: string } } | { jwt: { expiryTimeSeconds?: number; issuer: string; secret: string } } | { oauth2: { accessToken: string } }

OptionalbaseRequestConfig?: any

host: string

Optionalmiddlewares?: { onError?: (...args: [any, ...unknown[]]) => void; onResponse?: (...args: [any, ...unknown[]]) => void;}

OptionalonError?: (...args: [any, ...unknown[]]) => void

OptionalonResponse?: (...args: [any, ...unknown[]]) => void

OptionalnoCheckAtlassianToken?: boolean

Returns BaseClient

Properties

Protected Readonlyconfig

Type declaration

OptionalapiPrefix?: string

Optionalauthentication?: | { basic: { apiToken: string; email: string } } | { jwt: { expiryTimeSeconds?: number; issuer: string; secret: string } } | { oauth2: { accessToken: string } }

OptionalbaseRequestConfig?: any

host: string

Optionalmiddlewares?: { onError?: (...args: [any, ...unknown[]]) => void; onResponse?: (...args: [any, ...unknown[]]) => void;}

OptionalonError?: (...args: [any, ...unknown[]]) => void

OptionalonResponse?: (...args: [any, ...unknown[]]) => void

OptionalnoCheckAtlassianToken?: boolean

Methods

Protectedencode

Parameters

Returns string

ProtectedparamSerializer

Parameters

Returns string

ProtectedremoveUndefinedProperties

Parameters

Returns Record<string, any>

sendRequest

Type Parameters

Parameters

Returns Promise<T>

Type Parameters

Parameters

Returns Promise<void>

Settings

On This Page

`Optional`apiPrefix?: string

`Optional`authentication?:
| { basic: { apiToken: string; email: string } }
| { jwt: { expiryTimeSeconds?: number; issuer: string; secret: string } }
| { oauth2: { accessToken: string } }

`Optional`baseRequestConfig?: any

`Optional`middlewares?: {
onError?: (...args: [any, ...unknown[]]) => void;
onResponse?: (...args: [any, ...unknown[]]) => void;
}

`Optional`onError?: (...args: [any, ...unknown[]]) => void

`Optional`onResponse?: (...args: [any, ...unknown[]]) => void

`Optional`noCheckAtlassianToken?: boolean

`Protected` `Readonly`config

`Optional`apiPrefix?: string

`Optional`authentication?:
| { basic: { apiToken: string; email: string } }
| { jwt: { expiryTimeSeconds?: number; issuer: string; secret: string } }
| { oauth2: { accessToken: string } }

`Optional`baseRequestConfig?: any

`Optional`middlewares?: {
onError?: (...args: [any, ...unknown[]]) => void;
onResponse?: (...args: [any, ...unknown[]]) => void;
}

`Optional`onError?: (...args: [any, ...unknown[]]) => void

`Optional`onResponse?: (...args: [any, ...unknown[]]) => void

`Optional`noCheckAtlassianToken?: boolean

`Protected`encode

`Protected`paramSerializer

`Protected`removeUndefinedProperties