Options
All
  • Public
  • Public/Protected
  • All
Menu

Okuna.js

Index

Classes

Interfaces

Functions

Functions

Const buildUrl

  • buildUrl(apiUrl: string, paths: string[], params: object): string

  • buildUrl() Creates a fetchable URL

    Parameters

    • apiUrl: string

      The URL address of the Okuna API server

    • paths: string[]

      An array containing additional paths for the endpoint

    • params: object

      Key-value properties to append to the URL (mainly used for GET requests)

    Returns string

    • The final URL to fetch

Const encodeParent

  • encodeParent(input: string): string

  • encodeParent() - Encodes a parent key (nested objects)

    Parameters

    • input: string

      The parent key

    Returns string

    • The encoded parent key

Const getRequestStrategy

  • getRequestStrategy(strategy: any): any

Const queryString

  • queryString(obj: object, parent?: string | null): string

  • queryString() - Builds a querystring from an object

    Parameters

    • obj: object

      The object to convert to a querystring

    • Default value parent: string | null = null

      The current parent key

    Returns string

Generated using TypeDoc