Options
All
  • Public
  • Public/Protected
  • All
Menu

Index

Functions

callbackify

  • callbackify(fn: function): function
  • callbackify<TResult>(fn: function): function
  • callbackify<T1>(fn: function): function
  • callbackify<T1, TResult>(fn: function): function
  • callbackify<T1, T2>(fn: function): function
  • callbackify<T1, T2, TResult>(fn: function): function
  • callbackify<T1, T2, T3>(fn: function): function
  • callbackify<T1, T2, T3, TResult>(fn: function): function
  • callbackify<T1, T2, T3, T4>(fn: function): function
  • callbackify<T1, T2, T3, T4, TResult>(fn: function): function
  • callbackify<T1, T2, T3, T4, T5>(fn: function): function
  • callbackify<T1, T2, T3, T4, T5, TResult>(fn: function): function
  • callbackify<T1, T2, T3, T4, T5, T6>(fn: function): function
  • callbackify<T1, T2, T3, T4, T5, T6, TResult>(fn: function): function
  • Parameters

    • fn: function
        • (): Promise<void>
        • Returns Promise<void>

    Returns function

      • (callback: function): void
  • Type parameters

    • TResult

    Parameters

    • fn: function
        • (): Promise<TResult>
        • Returns Promise<TResult>

    Returns function

      • (callback: function): void
      • Parameters

        Returns void

  • Type parameters

    • T1

    Parameters

    • fn: function
        • (arg1: T1): Promise<void>
        • Parameters

          • arg1: T1

          Returns Promise<void>

    Returns function

      • (arg1: T1, callback: function): void
  • Type parameters

    • T1

    • TResult

    Parameters

    • fn: function
        • (arg1: T1): Promise<TResult>
        • Parameters

          • arg1: T1

          Returns Promise<TResult>

    Returns function

      • (arg1: T1, callback: function): void
      • Parameters

        Returns void

  • Type parameters

    • T1

    • T2

    Parameters

    • fn: function
        • (arg1: T1, arg2: T2): Promise<void>
        • Parameters

          • arg1: T1
          • arg2: T2

          Returns Promise<void>

    Returns function

      • (arg1: T1, arg2: T2, callback: function): void
  • Type parameters

    • T1

    • T2

    • TResult

    Parameters

    • fn: function
        • (arg1: T1, arg2: T2): Promise<TResult>
        • Parameters

          • arg1: T1
          • arg2: T2

          Returns Promise<TResult>

    Returns function

      • (arg1: T1, arg2: T2, callback: function): void
      • Parameters

        • arg1: T1
        • arg2: T2
        • callback: function

        Returns void

  • Type parameters

    • T1

    • T2

    • T3

    Parameters

    • fn: function
        • (arg1: T1, arg2: T2, arg3: T3): Promise<void>
        • Parameters

          • arg1: T1
          • arg2: T2
          • arg3: T3

          Returns Promise<void>

    Returns function

      • (arg1: T1, arg2: T2, arg3: T3, callback: function): void
      • Parameters

        Returns void

  • Type parameters

    • T1

    • T2

    • T3

    • TResult

    Parameters

    • fn: function
        • (arg1: T1, arg2: T2, arg3: T3): Promise<TResult>
        • Parameters

          • arg1: T1
          • arg2: T2
          • arg3: T3

          Returns Promise<TResult>

    Returns function

      • (arg1: T1, arg2: T2, arg3: T3, callback: function): void
      • Parameters

        • arg1: T1
        • arg2: T2
        • arg3: T3
        • callback: function

        Returns void

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    Parameters

    • fn: function
        • (arg1: T1, arg2: T2, arg3: T3, arg4: T4): Promise<void>
        • Parameters

          • arg1: T1
          • arg2: T2
          • arg3: T3
          • arg4: T4

          Returns Promise<void>

    Returns function

      • (arg1: T1, arg2: T2, arg3: T3, arg4: T4, callback: function): void
      • Parameters

        Returns void

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • TResult

    Parameters

    • fn: function
        • (arg1: T1, arg2: T2, arg3: T3, arg4: T4): Promise<TResult>
        • Parameters

          • arg1: T1
          • arg2: T2
          • arg3: T3
          • arg4: T4

          Returns Promise<TResult>

    Returns function

      • (arg1: T1, arg2: T2, arg3: T3, arg4: T4, callback: function): void
      • Parameters

        • arg1: T1
        • arg2: T2
        • arg3: T3
        • arg4: T4
        • callback: function

        Returns void

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    Parameters

    • fn: function
        • (arg1: T1, arg2: T2, arg3: T3, arg4: T4, arg5: T5): Promise<void>
        • Parameters

          • arg1: T1
          • arg2: T2
          • arg3: T3
          • arg4: T4
          • arg5: T5

          Returns Promise<void>

    Returns function

      • (arg1: T1, arg2: T2, arg3: T3, arg4: T4, arg5: T5, callback: function): void
      • Parameters

        Returns void

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • TResult

    Parameters

    • fn: function
        • (arg1: T1, arg2: T2, arg3: T3, arg4: T4, arg5: T5): Promise<TResult>
        • Parameters

          • arg1: T1
          • arg2: T2
          • arg3: T3
          • arg4: T4
          • arg5: T5

          Returns Promise<TResult>

    Returns function

      • (arg1: T1, arg2: T2, arg3: T3, arg4: T4, arg5: T5, callback: function): void
      • Parameters

        • arg1: T1
        • arg2: T2
        • arg3: T3
        • arg4: T4
        • arg5: T5
        • callback: function

        Returns void

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    Parameters

    • fn: function
        • (arg1: T1, arg2: T2, arg3: T3, arg4: T4, arg5: T5, arg6: T6): Promise<void>
        • Parameters

          • arg1: T1
          • arg2: T2
          • arg3: T3
          • arg4: T4
          • arg5: T5
          • arg6: T6

          Returns Promise<void>

    Returns function

      • (arg1: T1, arg2: T2, arg3: T3, arg4: T4, arg5: T5, arg6: T6, callback: function): void
      • Parameters

        • arg1: T1
        • arg2: T2
        • arg3: T3
        • arg4: T4
        • arg5: T5
        • arg6: T6
        • callback: function

        Returns void

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • TResult

    Parameters

    • fn: function
        • (arg1: T1, arg2: T2, arg3: T3, arg4: T4, arg5: T5, arg6: T6): Promise<TResult>
        • Parameters

          • arg1: T1
          • arg2: T2
          • arg3: T3
          • arg4: T4
          • arg5: T5
          • arg6: T6

          Returns Promise<TResult>

    Returns function

      • (arg1: T1, arg2: T2, arg3: T3, arg4: T4, arg5: T5, arg6: T6, callback: function): void
      • Parameters

        • arg1: T1
        • arg2: T2
        • arg3: T3
        • arg4: T4
        • arg5: T5
        • arg6: T6
        • callback: function

        Returns void

debuglog

  • debuglog(key: string): function
  • Parameters

    • key: string

    Returns function

      • (msg: string, ...param: any[]): void
      • Parameters

        • msg: string
        • Rest ...param: any[]

        Returns void

deprecate

  • deprecate<T>(fn: T, message: string): T
  • Type parameters

    • T: Function

    Parameters

    • fn: T
    • message: string

    Returns T

format

  • format(format: any, ...param: any[]): string
  • Parameters

    • format: any
    • Rest ...param: any[]

    Returns string

formatWithOptions

  • formatWithOptions(inspectOptions: InspectOptions, format: string, ...param: any[]): string
  • Parameters

    Returns string

inherits

  • inherits(constructor: any, superConstructor: any): void
  • Parameters

    • constructor: any
    • superConstructor: any

    Returns void

isArray

  • isArray(object: any): boolean
  • deprecated

    since v4.0.0 - use Array.isArray() instead.

    Parameters

    • object: any

    Returns boolean

isBoolean

  • isBoolean(object: any): boolean
  • deprecated

    since v4.0.0 - use typeof value === 'boolean' instead.

    Parameters

    • object: any

    Returns boolean

isBuffer

  • isBuffer(object: any): boolean
  • deprecated

    since v4.0.0 - use Buffer.isBuffer() instead.

    Parameters

    • object: any

    Returns boolean

isDate

  • isDate(object: any): boolean
  • deprecated

    since v4.0.0 - use util.types.isDate() instead.

    Parameters

    • object: any

    Returns boolean

isDeepStrictEqual

  • isDeepStrictEqual(val1: any, val2: any): boolean
  • Parameters

    • val1: any
    • val2: any

    Returns boolean

isError

  • isError(object: any): boolean
  • deprecated

    since v4.0.0 - use util.types.isNativeError() instead.

    Parameters

    • object: any

    Returns boolean

isFunction

  • isFunction(object: any): boolean
  • deprecated

    since v4.0.0 - use typeof value === 'function' instead.

    Parameters

    • object: any

    Returns boolean

isNull

  • isNull(object: any): boolean
  • deprecated

    since v4.0.0 - use value === null instead.

    Parameters

    • object: any

    Returns boolean

isNullOrUndefined

  • isNullOrUndefined(object: any): boolean
  • deprecated

    since v4.0.0 - use value === null || value === undefined instead.

    Parameters

    • object: any

    Returns boolean

isNumber

  • isNumber(object: any): boolean
  • deprecated

    since v4.0.0 - use typeof value === 'number' instead.

    Parameters

    • object: any

    Returns boolean

isObject

  • isObject(object: any): boolean
  • deprecated

    since v4.0.0 - use value !== null && typeof value === 'object' instead.

    Parameters

    • object: any

    Returns boolean

isPrimitive

  • isPrimitive(object: any): boolean
  • deprecated

    since v4.0.0 - use (typeof value !== 'object' && typeof value !== 'function') || value === null instead.

    Parameters

    • object: any

    Returns boolean

isRegExp

  • isRegExp(object: any): boolean
  • deprecated

    since v4.0.0 - use util.types.isRegExp() instead.

    Parameters

    • object: any

    Returns boolean

isString

  • isString(object: any): boolean
  • deprecated

    since v4.0.0 - use typeof value === 'string' instead.

    Parameters

    • object: any

    Returns boolean

isSymbol

  • isSymbol(object: any): boolean
  • deprecated

    since v4.0.0 - use typeof value === 'symbol' instead.

    Parameters

    • object: any

    Returns boolean

isUndefined

  • isUndefined(object: any): boolean
  • deprecated

    since v4.0.0 - use value === undefined instead.

    Parameters

    • object: any

    Returns boolean

log

  • log(string: string): void
  • deprecated

    since v0.11.3 - use a third party module instead.

    Parameters

    • string: string

    Returns void

promisify

  • promisify<TCustom>(fn: CustomPromisify<TCustom>): TCustom
  • promisify<TResult>(fn: function): function
  • promisify(fn: function): function
  • promisify<T1, TResult>(fn: function): function
  • promisify<T1>(fn: function): function
  • promisify<T1, T2, TResult>(fn: function): function
  • promisify<T1, T2>(fn: function): function
  • promisify<T1, T2, T3, TResult>(fn: function): function
  • promisify<T1, T2, T3>(fn: function): function
  • promisify<T1, T2, T3, T4, TResult>(fn: function): function
  • promisify<T1, T2, T3, T4>(fn: function): function
  • promisify<T1, T2, T3, T4, T5, TResult>(fn: function): function
  • promisify<T1, T2, T3, T4, T5>(fn: function): function
  • promisify(fn: Function): Function
  • Type parameters

    • TCustom: Function

    Parameters

    Returns TCustom

  • Type parameters

    • TResult

    Parameters

    • fn: function
        • (callback: function): void
        • Parameters

          • callback: function
              • (err: Error | null, result: TResult): void
              • Parameters

                • err: Error | null
                • result: TResult

                Returns void

          Returns void

    Returns function

      • (): Promise<TResult>
      • Returns Promise<TResult>

  • Parameters

    • fn: function
        • (callback: function): void
        • Parameters

          • callback: function
              • (err?: Error | null): void
              • Parameters

                • Optional err: Error | null

                Returns void

          Returns void

    Returns function

      • (): Promise<void>
      • Returns Promise<void>

  • Type parameters

    • T1

    • TResult

    Parameters

    • fn: function
        • (arg1: T1, callback: function): void
        • Parameters

          • arg1: T1
          • callback: function
              • (err: Error | null, result: TResult): void
              • Parameters

                • err: Error | null
                • result: TResult

                Returns void

          Returns void

    Returns function

      • (arg1: T1): Promise<TResult>
      • Parameters

        • arg1: T1

        Returns Promise<TResult>

  • Type parameters

    • T1

    Parameters

    • fn: function
        • (arg1: T1, callback: function): void
        • Parameters

          • arg1: T1
          • callback: function
              • (err?: Error | null): void
              • Parameters

                • Optional err: Error | null

                Returns void

          Returns void

    Returns function

      • (arg1: T1): Promise<void>
      • Parameters

        • arg1: T1

        Returns Promise<void>

  • Type parameters

    • T1

    • T2

    • TResult

    Parameters

    • fn: function
        • (arg1: T1, arg2: T2, callback: function): void
        • Parameters

          • arg1: T1
          • arg2: T2
          • callback: function
              • (err: Error | null, result: TResult): void
              • Parameters

                • err: Error | null
                • result: TResult

                Returns void

          Returns void

    Returns function

      • (arg1: T1, arg2: T2): Promise<TResult>
      • Parameters

        • arg1: T1
        • arg2: T2

        Returns Promise<TResult>

  • Type parameters

    • T1

    • T2

    Parameters

    • fn: function
        • (arg1: T1, arg2: T2, callback: function): void
        • Parameters

          • arg1: T1
          • arg2: T2
          • callback: function
              • (err?: Error | null): void
              • Parameters

                • Optional err: Error | null

                Returns void

          Returns void

    Returns function

      • (arg1: T1, arg2: T2): Promise<void>
      • Parameters

        • arg1: T1
        • arg2: T2

        Returns Promise<void>

  • Type parameters

    • T1

    • T2

    • T3

    • TResult

    Parameters

    • fn: function
        • (arg1: T1, arg2: T2, arg3: T3, callback: function): void
        • Parameters

          • arg1: T1
          • arg2: T2
          • arg3: T3
          • callback: function
              • (err: Error | null, result: TResult): void
              • Parameters

                • err: Error | null
                • result: TResult

                Returns void

          Returns void

    Returns function

      • (arg1: T1, arg2: T2, arg3: T3): Promise<TResult>
      • Parameters

        • arg1: T1
        • arg2: T2
        • arg3: T3

        Returns Promise<TResult>

  • Type parameters

    • T1

    • T2

    • T3

    Parameters

    • fn: function
        • (arg1: T1, arg2: T2, arg3: T3, callback: function): void
        • Parameters

          • arg1: T1
          • arg2: T2
          • arg3: T3
          • callback: function
              • (err?: Error | null): void
              • Parameters

                • Optional err: Error | null

                Returns void

          Returns void

    Returns function

      • (arg1: T1, arg2: T2, arg3: T3): Promise<void>
      • Parameters

        • arg1: T1
        • arg2: T2
        • arg3: T3

        Returns Promise<void>

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • TResult

    Parameters

    • fn: function
        • (arg1: T1, arg2: T2, arg3: T3, arg4: T4, callback: function): void
        • Parameters

          • arg1: T1
          • arg2: T2
          • arg3: T3
          • arg4: T4
          • callback: function
              • (err: Error | null, result: TResult): void
              • Parameters

                • err: Error | null
                • result: TResult

                Returns void

          Returns void

    Returns function

      • (arg1: T1, arg2: T2, arg3: T3, arg4: T4): Promise<TResult>
      • Parameters

        • arg1: T1
        • arg2: T2
        • arg3: T3
        • arg4: T4

        Returns Promise<TResult>

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    Parameters

    • fn: function
        • (arg1: T1, arg2: T2, arg3: T3, arg4: T4, callback: function): void
        • Parameters

          • arg1: T1
          • arg2: T2
          • arg3: T3
          • arg4: T4
          • callback: function
              • (err?: Error | null): void
              • Parameters

                • Optional err: Error | null

                Returns void

          Returns void

    Returns function

      • (arg1: T1, arg2: T2, arg3: T3, arg4: T4): Promise<void>
      • Parameters

        • arg1: T1
        • arg2: T2
        • arg3: T3
        • arg4: T4

        Returns Promise<void>

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • TResult

    Parameters

    • fn: function
        • (arg1: T1, arg2: T2, arg3: T3, arg4: T4, arg5: T5, callback: function): void
        • Parameters

          • arg1: T1
          • arg2: T2
          • arg3: T3
          • arg4: T4
          • arg5: T5
          • callback: function
              • (err: Error | null, result: TResult): void
              • Parameters

                • err: Error | null
                • result: TResult

                Returns void

          Returns void

    Returns function

      • (arg1: T1, arg2: T2, arg3: T3, arg4: T4, arg5: T5): Promise<TResult>
      • Parameters

        • arg1: T1
        • arg2: T2
        • arg3: T3
        • arg4: T4
        • arg5: T5

        Returns Promise<TResult>

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    Parameters

    • fn: function
        • (arg1: T1, arg2: T2, arg3: T3, arg4: T4, arg5: T5, callback: function): void
        • Parameters

          • arg1: T1
          • arg2: T2
          • arg3: T3
          • arg4: T4
          • arg5: T5
          • callback: function
              • (err?: Error | null): void
              • Parameters

                • Optional err: Error | null

                Returns void

          Returns void

    Returns function

      • (arg1: T1, arg2: T2, arg3: T3, arg4: T4, arg5: T5): Promise<void>
      • Parameters

        • arg1: T1
        • arg2: T2
        • arg3: T3
        • arg4: T4
        • arg5: T5

        Returns Promise<void>

  • Parameters

    • fn: Function

    Returns Function

Generated using TypeDoc