Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • export=

Index

Constructors

constructor

  • new export=(method: string, domain: string, resource: string, headers: Record<string, string>, data: Record<string, null | string | number | object>, queryParameters: Record<string, string | number>, pathParameters: Record<string, string | number>): export=
  • Parameters

    • method: string
    • domain: string
    • resource: string
    • headers: Record<string, string>
    • data: Record<string, null | string | number | object>
    • queryParameters: Record<string, string | number>
    • pathParameters: Record<string, string | number>

    Returns export=

Properties

Private _data

_data: Record<string, null | string | number | object>

Private _domain

_domain: string

Private _headers

_headers: Record<string, string>

Private _method

_method: string

Private _pathParameters

_pathParameters: Record<string, string | number>

Private _queryParameters

_queryParameters: Record<string, string | number>

Private _resource

_resource: string

Accessors

domain

  • get domain(): string
  • Returns string

method

  • get method(): string
  • Returns string

path

  • get path(): Record<string, string | number>
  • Returns Record<string, string | number>

query

  • get query(): Record<string, string | number>
  • Returns Record<string, string | number>

resource

  • get resource(): string
  • Returns string

Methods

body

  • body(keys?: null | string[], allowEmpty?: boolean, allowNull?: boolean): Record<string, null | string | number | object>
  • Parameters

    • keys: null | string[] = null
    • allowEmpty: boolean = false
    • allowNull: boolean = false

    Returns Record<string, null | string | number | object>

desktop

  • desktop(platform?: string): boolean
  • Parameters

    • platform: string = 'Any'

    Returns boolean

header

  • header(key: string): string
  • Parameters

    • key: string

    Returns string

headers

  • headers(): Record<string, string>
  • Returns Record<string, string>

mobile

  • mobile(platform?: string): boolean
  • Parameters

    • platform: string = 'Any'

    Returns boolean

secure

  • secure(): boolean
  • Returns boolean

Generated using TypeDoc