TransportAPIClient

Class

Properties​

NameTypeDescription
apiUrlstring-
optionsTransportAPIOptions-
supportedAPIVersionstring-

Members​

constructor​

(options: TransportAPIOptions) => TransportAPIClient

Parameters​

NameTypeDescription
optionsTransportAPIOptions-

createFormData​

(imageDataOrPaths: string | Buffer | ReadStream[]) => FormData

Parameters​

NameTypeDescription
imageDataOrPathsstring | Buffer | ReadStream[]-

createRequestHeaders​

(formData: FormData) => Headers

Parameters​

NameTypeDescription
formDataFormData-

getImageBytes​

(imagePathOrBuffer: string | Buffer | ReadStream) => Buffer | Stream

Parameters​

NameTypeDescription
imagePathOrBufferstring | Buffer | ReadStream-

getParametrizedApiUrl​

() => any

selectApiBaseUrl​

() => string

send​

(imageDataOrPaths: string | Buffer | ReadStream[]) => Promise

Parameters​

NameTypeDescription
imageDataOrPathsstring | Buffer | ReadStream[]-

validateOptions​

(options: TransportAPIOptions) => void

Parameters​

NameTypeDescription
optionsTransportAPIOptions-

Source: transport/index.ts:12