Class
A client for interacting with the Carmen Cloud Vehicle API.
Properties
| Name | Type | Description |
|---|
apiUrl | string | - |
options | VehicleAPIOptions | An object containing configuration options for the client. |
supportedAPIVersion | string | - |
Members
constructor
(options: VehicleAPIOptions) => VehicleAPIClient
Instantiates the client with a fixed set of options.
Parameters
| Name | Type | Description |
|---|
options | VehicleAPIOptions | An object containing configuration options for the client. |
(imageDataOrPath: string | Buffer | ReadStream) => FormData
Parameters
| Name | Type | Description |
|---|
imageDataOrPath | string | Buffer | ReadStream | - |
(formData: FormData) => Headers
Parameters
| Name | Type | Description |
|---|
formData | FormData | - |
createServiceParameter
() => string
getImageBytes
(imagePathOrBuffer: string | Buffer | ReadStream) => Buffer | Stream
Parameters
| Name | Type | Description |
|---|
imagePathOrBuffer | string | Buffer | ReadStream | - |
getParametrizedApiUrl
() => any
selectApiBaseUrl
() => string
send
(imageDataOrPath: string | Buffer | ReadStream) => Promise
Sends a request to the Vehicle API.
Parameters
| Name | Type | Description |
|---|
imageDataOrPath | string | Buffer | ReadStream | The image (specified with a path, a Buffer or a
Node.js ReadStream) to be sent in the request. |
Source: vehicle/index.ts:15
