Module olp-sdk-core

Index

Enumerations

Classes

Interfaces

Type Aliases

Variables

Functions

Type Aliases

ApiName

ApiName: "authorization" | "config" | "artifact" | "blob" | "index" | "ingest" | "interactive" | "metadata" | "notification" | "publish" | "query" | "statistics" | "stream" | "volatile-blob"

The list of the API endpoints names that the HERE Data SDK for TypeScript uses.

CacheType

CacheType: "api" | "age"

The list of the types could be saved in the cache.

EnvironmentName

EnvironmentName: "here" | "here-dev" | "here-cn" | "here-cn-dev" | "local" | string

The name of the environment that you use for work. You can also pass the URL string of your local or custom environment.

Variables

Const LIB_VERSION

LIB_VERSION: "2.0.0" = "2.0.0"

Const SENT_WITH_PARAM

SENT_WITH_PARAM: string = ...

The string for adding to the requests as query parameter.

Functions

addSentWithParam

addSentWithParam(url: string): string

- Defined in @here/olp-sdk-core/lib/utils/userAgent.ts:32
Adds sentWith param to the url.

Parameters
- url: string
  
  the string, representing the url
Returns string
the string, representing updated URL

getDataSize

getDataSize(data: string | number | boolean | object): number

- Defined in @here/olp-sdk-core/lib/utils/getDataSizeUtil.ts:28
Calculate memory size of javascript object, it is not an accurate value

Parameters
- data: string | number | boolean | object
Returns number
The size of value in bytes.

getEnvLookUpUrl

getEnvLookUpUrl(env: string): string

- Defined in @here/olp-sdk-core/lib/utils/getEnvLookupUrl.ts:38
Gets the URL string of the API Lookup Service.

Parameters
- env: string
  
  The environment that you use for work. You can also pass the URL string of your local or custom environment.
Returns string
Based on the specified environment, the URL string of the API Lookup Service or the URL string of the custom service.

Generated using TypeDoc