diff --git a/docs/classes/RateLimitError.html b/docs/classes/RateLimitError.html index 6952a85..3d3071c 100644 --- a/docs/classes/RateLimitError.html +++ b/docs/classes/RateLimitError.html @@ -1,4 +1,4 @@ -RateLimitError | @brainspore/hypernexus

Class RateLimitError

Hierarchy (View Summary)

Constructors

constructor +RateLimitError | @brainspore/hypernexus

Class RateLimitError

Hierarchy (View Summary)

Constructors

constructor

Properties

cause? data? message @@ -10,7 +10,7 @@ prepareStackTrace? stackTraceLimit

Methods

captureStackTrace -

Constructors

constructor

Properties

Optionalcause

cause?: unknown

Optionaldata

data?: any

message

message: string

name

name: string

OptionalretryAfter

retryAfter?: number

Optionalstack

stack?: string

OptionalstatusCode

statusCode?: number

Optionaltimeout

timeout?: number

Static OptionalprepareStackTrace

prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any

Optional override for formatting stack traces

+

Constructors

constructor

Properties

Optionalcause

cause?: unknown

Optionaldata

data?: any

message

message: string

name

name: string

OptionalretryAfter

retryAfter?: number

Optionalstack

stack?: string

OptionalstatusCode

statusCode?: number

Optionaltimeout

timeout?: number

Static OptionalprepareStackTrace

prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any

Optional override for formatting stack traces

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

StaticstackTraceLimit

stackTraceLimit: number

Methods

StaticcaptureStackTrace

  • captureStackTrace(targetObject: object, constructorOpt?: Function): void

    Create .stack property on a target object

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/docs/classes/TimeoutError.html b/docs/classes/TimeoutError.html index 090ac51..7662794 100644 --- a/docs/classes/TimeoutError.html +++ b/docs/classes/TimeoutError.html @@ -1,4 +1,4 @@ -TimeoutError | @brainspore/hypernexus

Class TimeoutError

Hierarchy (View Summary)

Constructors

constructor +TimeoutError | @brainspore/hypernexus

Class TimeoutError

Hierarchy (View Summary)

Constructors

constructor

Properties

cause? data? message @@ -9,7 +9,7 @@ prepareStackTrace? stackTraceLimit

Methods

captureStackTrace -

Constructors

constructor

Properties

Optionalcause

cause?: unknown

Optionaldata

data?: any

message

message: string

name

name: string

Optionalstack

stack?: string

OptionalstatusCode

statusCode?: number

Optionaltimeout

timeout?: number

Static OptionalprepareStackTrace

prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any

Optional override for formatting stack traces

+

Constructors

constructor

Properties

Optionalcause

cause?: unknown

Optionaldata

data?: any

message

message: string

name

name: string

Optionalstack

stack?: string

OptionalstatusCode

statusCode?: number

Optionaltimeout

timeout?: number

Static OptionalprepareStackTrace

prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any

Optional override for formatting stack traces

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

StaticstackTraceLimit

stackTraceLimit: number

Methods

StaticcaptureStackTrace

  • captureStackTrace(targetObject: object, constructorOpt?: Function): void

    Create .stack property on a target object

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/docs/classes/Transport.html b/docs/classes/Transport.html index aa47f18..b882e7f 100644 --- a/docs/classes/Transport.html +++ b/docs/classes/Transport.html @@ -16,7 +16,7 @@

Throws

When a request fails

Throws

When rate limit is exceeded

Throws

When request times out

-

Constructors

constructor +

Constructors

constructor

Methods

addMiddleware batch clearAllCaches @@ -28,7 +28,7 @@ patch post put -

Constructors

constructor

Methods

addMiddleware

  • addMiddleware(
        middleware: (
            config: AxiosRequestConfig,
        ) => AxiosRequestConfig<any> | Promise<AxiosRequestConfig<any>>,
    ): void

    Parameters

    • middleware: (
          config: AxiosRequestConfig,
      ) => AxiosRequestConfig<any> | Promise<AxiosRequestConfig<any>>

    Returns void

batch

  • batch<T>(request: AxiosRequestConfig<any>[], dependent?: boolean): Promise<T[]>

    Executes multiple HTTP requests in parallel or sequentially

    +

Constructors

constructor

Methods

addMiddleware

  • addMiddleware(
        middleware: (
            config: AxiosRequestConfig,
        ) => AxiosRequestConfig<any> | Promise<AxiosRequestConfig<any>>,
    ): void

    Parameters

    • middleware: (
          config: AxiosRequestConfig,
      ) => AxiosRequestConfig<any> | Promise<AxiosRequestConfig<any>>

    Returns void

batch

clearAllCaches

clearCache

  • clearCache(endpoint: string, options?: RequestOptions): void

    Parameters

    • endpoint: string
    • Optionaloptions: RequestOptions

    Returns void

cu

  • cu<T>(codeunit: string, payload?: any, options?: RequestOptions): Promise<T>

    Makes a POST request to a codeunit endpoint with optional payload and request options

    +

clearAllCaches

clearCache

  • clearCache(endpoint: string, options?: RequestOptions): void

    Parameters

    • endpoint: string
    • Optionaloptions: RequestOptions

    Returns void

cu

  • cu<T>(codeunit: string, payload?: any, options?: RequestOptions): Promise<T>

    Makes a POST request to a codeunit endpoint with optional payload and request options

    Type Parameters

    • T

      The expected response type

    Parameters

    • codeunit: string

      The codeunit endpoint URL

    • Optionalpayload: any

      Optional request payload/body data

    • Optionaloptions: RequestOptions

      Optional request configuration options

    Returns Promise<T>

    Promise that resolves with the response data

    Throws

    When the request fails with status code 500

    -

delete

  • delete<T>(endpoint: string, payload?: any, options?: RequestOptions): Promise<T>

    Type Parameters

    • T

    Parameters

    • endpoint: string
    • Optionalpayload: any
    • Optionaloptions: RequestOptions

    Returns Promise<T>

filter

  • filter(params: Record<string, any>): undefined | object

    Creates an OData filter query string from the provided parameters

    +

delete

  • delete<T>(endpoint: string, payload?: any, options?: RequestOptions): Promise<T>

    Type Parameters

    • T

    Parameters

    • endpoint: string
    • Optionalpayload: any
    • Optionaloptions: RequestOptions

    Returns Promise<T>

filter

  • filter(params: Record<string, any>): undefined | object

    Creates an OData filter query string from the provided parameters

    Parameters

    • params: Record<string, any>

      An object containing key-value pairs to be converted into filter conditions

    Returns undefined | object

    An object with the '$filter' property containing the generated OData filter string, or undefined if no valid parameters

    Throws

    When there is an error preparing the BC 365 filter query

    @@ -57,4 +57,4 @@

    Example

    filter({ name: "John", age: 30 })
    // Returns: { $filter: "name eq 'John' and age eq 30" }
    -

get

  • get<T>(
        endpoint: string,
        queryParams?: Record<string, any>,
        options?: RequestOptions,
    ): Promise<T>

    Type Parameters

    • T

    Parameters

    • endpoint: string
    • OptionalqueryParams: Record<string, any>
    • Optionaloptions: RequestOptions

    Returns Promise<T>

patch

  • patch<T>(endpoint: string, payload?: any, options?: RequestOptions): Promise<T>

    Type Parameters

    • T

    Parameters

    • endpoint: string
    • Optionalpayload: any
    • Optionaloptions: RequestOptions

    Returns Promise<T>

post

  • post<T>(endpoint: string, payload?: any, options?: RequestOptions): Promise<T>

    Type Parameters

    • T

    Parameters

    • endpoint: string
    • Optionalpayload: any
    • Optionaloptions: RequestOptions

    Returns Promise<T>

put

  • put<T>(endpoint: string, payload?: any, options?: RequestOptions): Promise<T>

    Type Parameters

    • T

    Parameters

    • endpoint: string
    • Optionalpayload: any
    • Optionaloptions: RequestOptions

    Returns Promise<T>

Settings

Member Visibility

On This Page

Constructors
Methods
+

get

patch

post

put

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/docs/classes/TransportError.html b/docs/classes/TransportError.html index 95b2835..1eb284d 100644 --- a/docs/classes/TransportError.html +++ b/docs/classes/TransportError.html @@ -1,4 +1,4 @@ -TransportError | @brainspore/hypernexus

Class TransportError

Hierarchy (View Summary)

Constructors

constructor +TransportError | @brainspore/hypernexus

Class TransportError

Hierarchy (View Summary)

Constructors

constructor

Properties

cause? data? message @@ -8,7 +8,7 @@ prepareStackTrace? stackTraceLimit

Methods

captureStackTrace -

Constructors

constructor

Properties

Optionalcause

cause?: unknown

Optionaldata

data?: any

message

message: string

name

name: string

Optionalstack

stack?: string

OptionalstatusCode

statusCode?: number

Static OptionalprepareStackTrace

prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any

Optional override for formatting stack traces

+

Constructors

constructor

Properties

Optionalcause

cause?: unknown

Optionaldata

data?: any

message

message: string

name

name: string

Optionalstack

stack?: string

OptionalstatusCode

statusCode?: number

Static OptionalprepareStackTrace

prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any

Optional override for formatting stack traces

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

StaticstackTraceLimit

stackTraceLimit: number

Methods

StaticcaptureStackTrace

  • captureStackTrace(targetObject: object, constructorOpt?: Function): void

    Create .stack property on a target object

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/docs/functions/CreateAuthHandler.html b/docs/functions/CreateAuthHandler.html index c707d8b..7a562ad 100644 --- a/docs/functions/CreateAuthHandler.html +++ b/docs/functions/CreateAuthHandler.html @@ -1,2 +1,2 @@ CreateAuthHandler | @brainspore/hypernexus

Function CreateAuthHandler

  • CreateAuthHandler(
        type: AuthTypes,
        credentials: Credentials,
        oath2Config?: null | OAuth2Config,
        accesTokenURL?: null | string,
        redisConfig?: null | RedisConfig,
    ): AuthHandler

    Create AuthHandler Factory

    -

    Parameters

    • type: AuthTypes
    • credentials: Credentials
    • oath2Config: null | OAuth2Config = null
    • accesTokenURL: null | string = null
    • redisConfig: null | RedisConfig = null

    Returns AuthHandler

Settings

Member Visibility
+

Parameters

Returns AuthHandler

Settings

Member Visibility
diff --git a/docs/functions/getConfig.html b/docs/functions/getConfig.html index 000f33d..4aca9fe 100644 --- a/docs/functions/getConfig.html +++ b/docs/functions/getConfig.html @@ -1,2 +1,2 @@ getConfig | @brainspore/hypernexus

Function getConfig

Get EnvConfig

-

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/docs/variables/transport-1.html b/docs/variables/transport-1.html index fdf1632..20aad2e 100644 --- a/docs/variables/transport-1.html +++ b/docs/variables/transport-1.html @@ -1 +1 @@ -transport | @brainspore/hypernexus

Variable transportConst

transport: Transport = ...

Settings

Member Visibility
+transport | @brainspore/hypernexus

Variable transportConst

transport: Transport = ...

Settings

Member Visibility