Options
All
  • Public
  • Public/Protected
  • All
Menu

@devnote-dev/pterojs

Index

Enumerations

Classes

Interfaces

Type Aliases

Properties

Variables

Functions

Type Aliases

External

External<T>: { external?: boolean } & T

Applies an external option to the request.

Type Parameters

  • T

Filter

Filter<T>: { filter?: string } & T

Applies a filter option to the request.

Type Parameters

  • T

FilterArray

FilterArray<T>: { filter?: string[] } & T

An internal form of the filter arguments.

Type Parameters

  • T

Include

Include<T>: { include?: string[] } & T

Applies an include option on the request.

Type Parameters

  • T

Method

Method: "GET" | "POST" | "PATCH" | "PUT" | "DELETE"

Resolvable

Resolvable<T>: string | number | Record<string, any> | T

The types object T can be resolved from, including itself.

Type Parameters

  • T

ScheduleTaskAction

ScheduleTaskAction: "backup" | "command" | "power"

Sort

Sort<T>: { sort?: string } & T

Applies a sort option on the request.

Type Parameters

  • T

Properties

version

version: string = "2.2.0"

Variables

caseConv

caseConv: { toCamelCase: (<T>(obj: any, options?: ConvertOptions) => T); toSnakeCase: (<T>(obj: any, options?: ConvertOptions) => T) }

Type declaration

configLoader

configLoader: { DEFAULT: { APPLICATION: { locations: { cache: boolean; fetch: boolean; max: number }; nests: { cache: boolean; fetch: boolean; max: number }; nodes: { cache: boolean; fetch: boolean; max: number }; servers: { cache: boolean; fetch: boolean; max: number }; users: { cache: boolean; fetch: boolean; max: number } }; CLIENT: { disableEvents: never[]; fetchClient: boolean; servers: { cache: boolean; fetch: boolean; max: number }; subUsers: { cache: boolean; fetch: boolean; max: number }; ws: boolean } }; appConfig: ((options?: FileConfig) => Record<string, OptionSpec>); clientConfig: ((options?: FileConfig) => Record<string, OptionSpec | any>); parseAs: ((from: Record<string, any>, to: Record<string, any>) => Record<string, any>) }

Type declaration

  • DEFAULT: { APPLICATION: { locations: { cache: boolean; fetch: boolean; max: number }; nests: { cache: boolean; fetch: boolean; max: number }; nodes: { cache: boolean; fetch: boolean; max: number }; servers: { cache: boolean; fetch: boolean; max: number }; users: { cache: boolean; fetch: boolean; max: number } }; CLIENT: { disableEvents: never[]; fetchClient: boolean; servers: { cache: boolean; fetch: boolean; max: number }; subUsers: { cache: boolean; fetch: boolean; max: number }; ws: boolean } }
    • APPLICATION: { locations: { cache: boolean; fetch: boolean; max: number }; nests: { cache: boolean; fetch: boolean; max: number }; nodes: { cache: boolean; fetch: boolean; max: number }; servers: { cache: boolean; fetch: boolean; max: number }; users: { cache: boolean; fetch: boolean; max: number } }
      • locations: { cache: boolean; fetch: boolean; max: number }
        • cache: boolean
        • fetch: boolean
        • max: number
      • nests: { cache: boolean; fetch: boolean; max: number }
        • cache: boolean
        • fetch: boolean
        • max: number
      • nodes: { cache: boolean; fetch: boolean; max: number }
        • cache: boolean
        • fetch: boolean
        • max: number
      • servers: { cache: boolean; fetch: boolean; max: number }
        • cache: boolean
        • fetch: boolean
        • max: number
      • users: { cache: boolean; fetch: boolean; max: number }
        • cache: boolean
        • fetch: boolean
        • max: number
    • CLIENT: { disableEvents: never[]; fetchClient: boolean; servers: { cache: boolean; fetch: boolean; max: number }; subUsers: { cache: boolean; fetch: boolean; max: number }; ws: boolean }
      • disableEvents: never[]
      • fetchClient: boolean
      • servers: { cache: boolean; fetch: boolean; max: number }
        • cache: boolean
        • fetch: boolean
        • max: number
      • subUsers: { cache: boolean; fetch: boolean; max: number }
        • cache: boolean
        • fetch: boolean
        • max: number
      • ws: boolean
  • appConfig: ((options?: FileConfig) => Record<string, OptionSpec>)
  • clientConfig: ((options?: FileConfig) => Record<string, OptionSpec | any>)
  • parseAs: ((from: Record<string, any>, to: Record<string, any>) => Record<string, any>)
      • (from: Record<string, any>, to: Record<string, any>): Record<string, any>
      • deprecated

        To be replaced with a better system.

        Parameters

        • from: Record<string, any>
        • to: Record<string, any>

        Returns Record<string, any>

Functions

buildQuery

escape

  • escape(input: string): string

  • Escapes (or removes) all the ASCII color and control codes from the given string. This is useful for cleaning logs from a server webssocket output.

    Parameters

    • input: string

      The string to escape.

    Returns string

    The escaped string.

Generated using TypeDoc