Class SearchApi

Hierarchy

SearchApi

Index

Constructors

constructor

Properties

Accessors

Methods

Object literals

authentications

Constructors

constructor

new SearchApi(basePath?: undefined | string): SearchApi

- Defined in lib/api/searchApi.ts:43
Parameters
- Optional basePath: undefined | string
Returns SearchApi

Properties

Protected _basePath

_basePath: string = defaultBasePath

Protected _defaultHeaders

_defaultHeaders: any

Protected _useQuerystring

_useQuerystring: boolean = false

Protected interceptors

interceptors: Interceptor[] = []

Accessors

basePath

get basePath(): string
set basePath(basePath: string): void

- Defined in lib/api/searchApi.ts:74
Returns string
- Defined in lib/api/searchApi.ts:62
Parameters
- basePath: string
Returns void

defaultHeaders

get defaultHeaders(): any
set defaultHeaders(defaultHeaders: any): void

- Defined in lib/api/searchApi.ts:70
Returns any
- Defined in lib/api/searchApi.ts:66
Parameters
- defaultHeaders: any
Returns void

useQuerystring

set useQuerystring(value: boolean): void

- Defined in lib/api/searchApi.ts:58
Parameters
- value: boolean
Returns void

Methods

addInterceptor

addInterceptor(interceptor: Interceptor): void

- Defined in lib/api/searchApi.ts:86
Parameters
- interceptor: Interceptor
Returns void

searchJsonGet

searchJsonGet(inlineObject13?: InlineObject13, options?: { headers: {} }): Promise<{ body: InlineResponse20024; response: IncomingMessage }>

- Defined in lib/api/searchApi.ts:95
summary

Search for a term

Parameters
- Optional inlineObject13: InlineObject13
- Default value options: { headers: {} } = {headers: {}}
  - headers: {}
    - [name: string]: string
Returns Promise<{ body: InlineResponse20024; response: IncomingMessage }>

setApiKey

setApiKey(key: SearchApiApiKeys, value: string): void

- Defined in lib/api/searchApi.ts:82
Parameters
- key: SearchApiApiKeys
- value: string
Returns void

setDefaultAuthentication

setDefaultAuthentication(auth: Authentication): void

- Defined in lib/api/searchApi.ts:78
Parameters
- auth: Authentication
Returns void

Object literals

Protected authentications

authentications: object

default

default: Authentication = <Authentication>new VoidAuth()

Generated using TypeDoc