kaven-utils
Options
All
  • Public
  • Public/Protected
  • All
Menu
export
version

2018-08-20

since

1.1.6

Hierarchy

  • APIRequestBase
    • APIRequest

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new APIRequest(url: string, encodeURIMethod?: StringMethod<string>): APIRequest

  • Warning: Remove "Action" field since version 1.1.12

    since

    1.1.12

    version

    2018-10-20

    Parameters

    • url: string
    • Optional encodeURIMethod: StringMethod<string>

    Returns APIRequest

Properties

Parameters

Parameters: TStringObject<TStringOrUndefined>

URL

URL: string

Static Readonly Signature

Signature: "Signature" = "Signature"

Static Readonly SignatureNonce

SignatureNonce: "SignatureNonce" = "SignatureNonce"

Static Readonly Timestamp

Timestamp: "Timestamp" = "Timestamp"

Accessors

EncodeURIMethod

  • get EncodeURIMethod(): (uri: string) => string
  • since

    1.1.12

    version

    2018-10-20

    Returns (uri: string) => string

      • (uri: string): string
      • since

        1.1.12

        version

        2018-10-20

        Parameters

        • uri: string

        Returns string

FullUrlWithoutSignature

  • get FullUrlWithoutSignature(): string
  • since

    1.1.17

    version

    2019-02-20

    Returns string

UrlWithoutSignature

  • get UrlWithoutSignature(): string
  • since

    1.1.12

    version

    2018-10-20

    Returns string

Methods

AddParameter

  • AddParameter(name: string, val?: string): APIRequest

  • Parameters

    • name: string
    • Optional val: string

    Returns APIRequest

AddSignatureNonce

  • Returns APIRequest

AddTimestamp

  • Returns APIRequest

Make

  • Make(accessSecret: string, signatureMethod: TSignatureMethod): string

  • Parameters

    • accessSecret: string
    • signatureMethod: TSignatureMethod

    Returns string

MakeByHMAC_SHA1

  • MakeByHMAC_SHA1(secret: string): string
  • memberof

    APIRequest

    version

    2018-08-20

    since

    1.1.6

    Parameters

    • secret: string

    Returns string

Static Verify

  • Verify(secret: string, url: string, signatureMethod: TSignatureMethod, encodeURIMethod?: StringMethod<string>, decodeURIMethod?: StringMethod<string>): true | APIRequestVerifyError

  • Parameters

    • secret: string
    • url: string
    • signatureMethod: TSignatureMethod
    • Optional encodeURIMethod: StringMethod<string>
    • Optional decodeURIMethod: StringMethod<string>

    Returns true | APIRequestVerifyError

Static VerifyByHMAC_SHA1

  • VerifyByHMAC_SHA1(secret: string, url: string): true | APIRequestVerifyError
  • version

    1.1.17

    since

    2018-10-20

    Parameters

    • secret: string
    • url: string

    Returns true | APIRequestVerifyError

Legend

  • Variable
  • Function
  • Function with type parameter
  • Type alias
  • Interface
  • Interface with type parameter
  • Class
  • Method
  • Enumeration
  • Inherited constructor
  • Static method

Generated using TypeDoc