Class AlgoliaApi

Hierarchy

ApiContext
- AlgoliaApi

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new AlgoliaApi(appId: string, apiKey: string, requestDriver: RequestDriver): AlgoliaApi

Overrides ApiContext.constructor
- Defined in algolia-api/algolia-api.ts:14
Parameters
- appId: string
- apiKey: string
- requestDriver: RequestDriver
Returns AlgoliaApi

Properties

Private apiKey

apiKey: string

Private appId

appId: string

indices

indices: IndicesApi

requestDriver

requestDriver: RequestDriver

Methods

createEndpoint

createEndpoint(requestDefinition: ApiRequestDefinition): ApiEndpoint

Inherited from ApiContext.createEndpoint
- Defined in api/api-context.ts:32
Parameters
- requestDefinition: ApiRequestDefinition
Returns ApiEndpoint

createRequestOptions

createRequestOptions(requestDefinition: ApiRequestDefinition, endpoint: ApiEndpoint): RequestOptions

Inherited from ApiContext.createRequestOptions
- Defined in api/api-context.ts:41
Parameters
- requestDefinition: ApiRequestDefinition
- endpoint: ApiEndpoint
Returns RequestOptions

doRequest

doRequest(requestDefinition: ApiRequestDefinition): Promise<ServerResponse>

Inherited from ApiContext.doRequest
- Defined in api/api-context.ts:61
Parameters
- requestDefinition: ApiRequestDefinition
Returns Promise<ServerResponse>

setHeader

setHeader(header: string, value: string): void

Inherited from ApiContext.setHeader
- Defined in api/api-context.ts:24
Parameters
- header: string
- value: string
Returns void

unsetHeader

unsetHeader(header: string): void

Inherited from ApiContext.unsetHeader
- Defined in api/api-context.ts:28
Parameters
- header: string
Returns void

Generated using TypeDoc