Options
All
  • Public
  • Public/Protected
  • All
Menu

RAML JS Parser 2

Index

External modules

External modules

"typings/main.d"

"typings/main.d":

"typings/main/ambient/Q/index.d"

"typings/main/ambient/Q/index.d":

"q"

"q":

Export assignment Q

  • If value is a Q promise, returns the promise. If value is a promise from another library it is coerced into a Q promise (where possible).

    Type parameters

    • T

    Parameters

    Returns Promise<T>

  • If value is not a promise, returns a promise that is fulfilled with value.

    Type parameters

    • T

    Parameters

    • value: T

    Returns Promise<T>

Deferred

Deferred:

promise

promise: Promise<T>

makeNodeResolver

  • makeNodeResolver(): function

  • Returns function

      • (reason: any, value: T): void

      • Parameters

        • reason: any
        • value: T

        Returns void

notify

  • notify(value: any): void

  • Parameters

    • value: any

    Returns void

reject

  • reject(reason: any): void

  • Parameters

    • reason: any

    Returns void

resolve

  • resolve(value: T): void

  • Parameters

    • value: T

    Returns void

IPromise

IPromise:

then

  • then<U>(onFulfill?: function, onReject?: function): IPromise<U>

  • Type parameters

    • U

    Parameters

    • Optional onFulfill: function
    • Optional onReject: function

    Returns IPromise<U>

Promise

  • Promise<T>(resolver: function): Promise<T>

  • Type parameters

    • T

    Parameters

    • resolver: function
        • (resolve: function, reject: function, notify: function): void

        • Parameters

          • resolve: function
          • reject: function
              • (reason: any): void

              • Parameters

                • reason: any

                Returns void

          • notify: function
              • (progress: any): void

              • Parameters

                • progress: any

                Returns void

          Returns void

    Returns Promise<T>

catch

  • catch<U>(onRejected: function): Promise<U>

  • A sugar method, equivalent to promise.then(undefined, onRejected).

    Type parameters

    • U

    Parameters

    • onRejected: function

    Returns Promise<U>

delay

  • Returns a promise that will have the same result as promise, but will only be fulfilled or rejected after at least ms milliseconds have passed.

    Parameters

    • ms: number

    Returns Promise<T>

delete

  • delete<U>(propertyName: String): Promise<U>

  • Type parameters

    • U

    Parameters

    • propertyName: String

    Returns Promise<U>

done

  • done(onFulfilled?: function, onRejected?: function, onProgress?: function): void

  • Much like then, but with different behavior around unhandled rejection. If there is an unhandled rejection, either because promise is rejected and no onRejected callback was provided, or because onFulfilled or onRejected threw an error or returned a rejected promise, the resulting rejection reason is thrown as an exception in a future turn of the event loop.

    This method should be used to terminate chains of promises that will not be passed elsewhere. Since exceptions thrown in then callbacks are consumed and transformed into rejections, exceptions at the end of the chain are easy to accidentally, silently ignore. By arranging for the exception to be thrown in a future turn of the event loop, so that it won't be caught, it causes an onerror event on the browser window, or an uncaughtException event on Node.js's process object.

    Exceptions thrown by done will have long stack traces, if Q.longStackSupport is set to true. If Q.onerror is set, exceptions will be delivered there instead of thrown in a future turn.

    The Golden Rule of done vs. then usage is: either return your promise to someone else, or if the chain ends with you, call done to terminate it.

    Parameters

    • Optional onFulfilled: function
        • (value: T): any

        • Parameters

          • value: T

          Returns any

    • Optional onRejected: function
        • (reason: any): any

        • Parameters

          • reason: any

          Returns any

    • Optional onProgress: function
        • (progress: any): any

        • Parameters

          • progress: any

          Returns any

    Returns void

fail

  • fail<U>(onRejected: function): Promise<U>

  • Type parameters

    • U

    Parameters

    • onRejected: function

    Returns Promise<U>

fapply

  • fapply<U>(args: any[]): Promise<U>

  • Type parameters

    • U

    Parameters

    • args: any[]

    Returns Promise<U>

fcall

  • fcall<U>(...args: any[]): Promise<U>

  • Type parameters

    • U

    Parameters

    • Rest ...args: any[]

    Returns Promise<U>

fin

  • fin(finallyCallback: function): Promise<T>

  • Like a finally clause, allows you to observe either the fulfillment or rejection of a promise, but to do so without modifying the final value. This is useful for collecting resources regardless of whether a job succeeded, like closing a database connection, shutting a server down, or deleting an unneeded key from an object.

    finally returns a promise, which will become resolved with the same fulfillment value or rejection reason as promise. However, if callback returns a promise, the resolution of the returned promise will be delayed until the promise returned from callback is finished.

    Parameters

    • finallyCallback: function
        • (): any

        • Returns any

    Returns Promise<T>

finally

  • finally(finallyCallback: function): Promise<T>

  • Like a finally clause, allows you to observe either the fulfillment or rejection of a promise, but to do so without modifying the final value. This is useful for collecting resources regardless of whether a job succeeded, like closing a database connection, shutting a server down, or deleting an unneeded key from an object.

    finally returns a promise, which will become resolved with the same fulfillment value or rejection reason as promise. However, if callback returns a promise, the resolution of the returned promise will be delayed until the promise returned from callback is finished.

    Parameters

    • finallyCallback: function
        • (): any

        • Returns any

    Returns Promise<T>

get

  • get<U>(propertyName: String): Promise<U>

  • Returns a promise to get the named property of an object. Essentially equivalent to

    promise.then(function (o) { return o[propertyName]; });

    Type parameters

    • U

    Parameters

    • propertyName: String

    Returns Promise<U>

inspect

  • Returns a "state snapshot" object, which will be in one of three forms:

    • { state: "pending" }
    • { state: "fulfilled", value: }
    • { state: "rejected", reason: }

    Returns PromiseState<T>

invoke

  • invoke<U>(methodName: String, ...args: any[]): Promise<U>

  • Returns a promise for the result of calling the named method of an object with the given variadic arguments. The object itself is this in the function, just like a synchronous method call.

    Type parameters

    • U

    Parameters

    • methodName: String
    • Rest ...args: any[]

    Returns Promise<U>

isFulfilled

  • isFulfilled(): boolean

  • Returns whether a given promise is in the fulfilled state. When the static version is used on non-promises, the result is always true.

    Returns boolean

isPending

  • isPending(): boolean

  • Returns whether a given promise is in the pending state. When the static version is used on non-promises, the result is always false.

    Returns boolean

isRejected

  • isRejected(): boolean

  • Returns whether a given promise is in the rejected state. When the static version is used on non-promises, the result is always false.

    Returns boolean

keys

  • Returns a promise for an array of the property names of an object. Essentially equivalent to

    promise.then(function (o) { return Object.keys(o); });

    Returns Promise<string[]>

nodeify

  • nodeify(callback: function): Promise<T>

  • If callback is a function, assumes it's a Node.js-style callback, and calls it as either callback(rejectionReason) when/if promise becomes rejected, or as callback(null, fulfillmentValue) when/if promise becomes fulfilled. If callback is not a function, simply returns promise.

    Parameters

    • callback: function
        • (reason: any, value: any): void

        • Parameters

          • reason: any
          • value: any

          Returns void

    Returns Promise<T>

post

  • post<U>(methodName: String, args: any[]): Promise<U>

  • Returns a promise for the result of calling the named method of an object with the given array of arguments. The object itself is this in the function, just like a synchronous method call. Essentially equivalent to

    promise.then(function (o) { return o[methodName].apply(o, args); });

    Type parameters

    • U

    Parameters

    • methodName: String
    • args: any[]

    Returns Promise<U>

progress

  • progress(onProgress: function): Promise<T>

  • A sugar method, equivalent to promise.then(undefined, undefined, onProgress).

    Parameters

    • onProgress: function
        • (progress: any): any

        • Parameters

          • progress: any

          Returns any

    Returns Promise<T>

set

  • set<U>(propertyName: String, value: any): Promise<U>

  • Type parameters

    • U

    Parameters

    • propertyName: String
    • value: any

    Returns Promise<U>

spread

  • spread<U>(onFulfilled: Function, onRejected?: Function): Promise<U>

  • Like then, but "spreads" the array into a variadic fulfillment handler. If any of the promises in the array are rejected, instead calls onRejected with the first rejected promise's rejection reason.

    This is especially useful in conjunction with all

    Type parameters

    • U

    Parameters

    • onFulfilled: Function
    • Optional onRejected: Function

    Returns Promise<U>

then

  • then<U>(onFulfill?: function, onReject?: function, onProgress?: Function): Promise<U>

  • The then method from the Promises/A+ specification, with an additional progress handler.

    Type parameters

    • U

    Parameters

    • Optional onFulfill: function
    • Optional onReject: function
    • Optional onProgress: Function

    Returns Promise<U>

thenReject

  • thenReject(reason: any): Promise<T>

  • A sugar method, equivalent to promise.then(function () { throw reason; }).

    Parameters

    • reason: any

    Returns Promise<T>

thenResolve

  • thenResolve<U>(value: U): Promise<U>

  • A sugar method, equivalent to promise.then(function () { return value; }).

    Type parameters

    • U

    Parameters

    • value: U

    Returns Promise<U>

timeout

  • timeout(ms: number, message?: string): Promise<T>

  • Parameters

    • ms: number
    • Optional message: string

    Returns Promise<T>

valueOf

  • valueOf(): any

  • Returns any

PromiseState

PromiseState:

Optional reason

reason: any

state

state: string

"fulfilled", "rejected", "pending"

Optional value

value: T

longStackSupport

longStackSupport: boolean

A settable property that lets you turn on long stack trace support. If turned on, "stack jumps" will be tracked across asynchronous promise operations, so that if an uncaught error is thrown by done or a rejection reason's stack property is inspected in a rejection callback, a long stack trace is produced.

onerror

onerror: function

A settable property that will intercept any uncaught errors that would otherwise be thrown in the next tick of the event loop, usually as a result of done. Can be useful for getting the full stack trace of an error in browsers, which is not usually possible with window.onerror.

Type declaration

    • (reason: any): void

    • Parameters

      • reason: any

      Returns void

all

  • Returns a promise that is fulfilled with an array containing the fulfillment value of each promise, or is rejected with the same rejection reason as the first promise to be rejected.

    Type parameters

    • T

    Parameters

    Returns Promise<T[]>

allResolved

  • Type parameters

    • T

    Parameters

    Returns Promise<Promise<T>[]>

allSettled

  • Returns a promise that is fulfilled with an array of promise state snapshots, but only after all the original promises have settled, i.e. become either fulfilled or rejected.

    Type parameters

    • T

    Parameters

    Returns Promise<PromiseState<T>[]>

async

  • async<T>(generatorFunction: any): function

  • This is an experimental tool for converting a generator function into a deferred function. This has the potential of reducing nested callbacks in engines that support yield.

    Type parameters

    • T

    Parameters

    • generatorFunction: any

    Returns function

      • Parameters

        • Rest ...args: any[]

        Returns Promise<T>

defer

  • Returns a "deferred" object with a: promise property resolve(value) method reject(reason) method notify(value) method makeNodeResolver() method

    Type parameters

    • T

    Returns Deferred<T>

delay

  • Returns a promise that will have the same result as promise, but will only be fulfilled or rejected after at least ms milliseconds have passed.

    Type parameters

    • T

    Parameters

    Returns Promise<T>

  • Returns a promise that will have the same result as promise, but will only be fulfilled or rejected after at least ms milliseconds have passed.

    Type parameters

    • T

    Parameters

    • value: T
    • ms: number

    Returns Promise<T>

  • Returns a promise that will be fulfilled with undefined after at least ms milliseconds have passed.

    Parameters

    • ms: number

    Returns Promise<void>

denodeify

  • denodeify<T>(nodeFunction: Function, ...args: any[]): function

  • Type parameters

    • T

    Parameters

    • nodeFunction: Function
    • Rest ...args: any[]

    Returns function

      • Parameters

        • Rest ...args: any[]

        Returns Promise<T>

fbind

  • fbind<T>(method: function, ...args: any[]): function

  • Currently "impossible" (and I use the term loosely) to implement due to TypeScript limitations as it is now. See: https://github.com/Microsoft/TypeScript/issues/1784 for discussion on it.

    Type parameters

    • T

    Parameters

    • method: function

        • Parameters

          • Rest ...args: any[]

          Returns T | IPromise<T>

    • Rest ...args: any[]

    Returns function

      • Parameters

        • Rest ...args: any[]

        Returns Promise<T>

fcall

  • fcall<T>(method: function, ...args: any[]): Promise<T>

  • Type parameters

    • T

    Parameters

    • method: function
        • (...args: any[]): T

        • Parameters

          • Rest ...args: any[]

          Returns T

    • Rest ...args: any[]

    Returns Promise<T>

invoke

  • invoke<T>(obj: any, functionName: string, ...args: any[]): Promise<T>

  • Type parameters

    • T

    Parameters

    • obj: any
    • functionName: string
    • Rest ...args: any[]

    Returns Promise<T>

isFulfilled

  • isFulfilled(promise: Promise<any>): boolean

  • Returns whether a given promise is in the fulfilled state. When the static version is used on non-promises, the result is always true.

    Parameters

    Returns boolean

isPending

  • isPending(promise: Promise<any>): boolean
  • isPending(object: any): boolean

  • Returns whether a given promise is in the pending state. When the static version is used on non-promises, the result is always false.

    Parameters

    Returns boolean

  • Returns whether a given promise is in the pending state. When the static version is used on non-promises, the result is always false.

    Parameters

    • object: any

    Returns boolean

isPromise

  • isPromise(object: any): boolean

  • Returns whether the given value is a Q promise.

    Parameters

    • object: any

    Returns boolean

isPromiseAlike

  • isPromiseAlike(object: any): boolean

  • Returns whether the given value is a promise (i.e. it's an object with a then function).

    Parameters

    • object: any

    Returns boolean

isRejected

  • isRejected(promise: Promise<any>): boolean

  • Returns whether a given promise is in the rejected state. When the static version is used on non-promises, the result is always false.

    Parameters

    Returns boolean

mcall

  • mcall<T>(obj: any, functionName: string, ...args: any[]): Promise<T>

  • Type parameters

    • T

    Parameters

    • obj: any
    • functionName: string
    • Rest ...args: any[]

    Returns Promise<T>

nbind

  • nbind<T>(nodeFunction: Function, thisArg: any, ...args: any[]): function

  • Type parameters

    • T

    Parameters

    • nodeFunction: Function
    • thisArg: any
    • Rest ...args: any[]

    Returns function

      • Parameters

        • Rest ...args: any[]

        Returns Promise<T>

nextTick

  • nextTick(callback: Function): void

  • Parameters

    • callback: Function

    Returns void

nfapply

  • nfapply<T>(nodeFunction: Function, args: any[]): Promise<T>

  • Type parameters

    • T

    Parameters

    • nodeFunction: Function
    • args: any[]

    Returns Promise<T>

nfbind

  • nfbind<T>(nodeFunction: Function, ...args: any[]): function

  • Type parameters

    • T

    Parameters

    • nodeFunction: Function
    • Rest ...args: any[]

    Returns function

      • Parameters

        • Rest ...args: any[]

        Returns Promise<T>

nfcall

  • nfcall<T>(nodeFunction: Function, ...args: any[]): Promise<T>

  • Type parameters

    • T

    Parameters

    • nodeFunction: Function
    • Rest ...args: any[]

    Returns Promise<T>

ninvoke

  • ninvoke<T>(nodeModule: any, functionName: string, ...args: any[]): Promise<T>

  • Type parameters

    • T

    Parameters

    • nodeModule: any
    • functionName: string
    • Rest ...args: any[]

    Returns Promise<T>

nmcall

  • nmcall<T>(nodeModule: any, functionName: string, ...args: any[]): Promise<T>

  • Type parameters

    • T

    Parameters

    • nodeModule: any
    • functionName: string
    • Rest ...args: any[]

    Returns Promise<T>

npost

  • npost<T>(nodeModule: any, functionName: string, args: any[]): Promise<T>

  • Type parameters

    • T

    Parameters

    • nodeModule: any
    • functionName: string
    • args: any[]

    Returns Promise<T>

nsend

  • nsend<T>(nodeModule: any, functionName: string, ...args: any[]): Promise<T>

  • Type parameters

    • T

    Parameters

    • nodeModule: any
    • functionName: string
    • Rest ...args: any[]

    Returns Promise<T>

promised

  • promised<T>(callback: function): function

  • Creates a new version of func that accepts any combination of promise and non-promise values, converting them to their fulfillment values before calling the original func. The returned version also always returns a promise: if func does a return or throw, then Q.promised(func) will return fulfilled or rejected promise, respectively.

    This can be useful for creating functions that accept either promises or non-promise values, and for ensuring that the function always returns a promise even in the face of unintentional thrown exceptions.

    Type parameters

    • T

    Parameters

    • callback: function
        • (...args: any[]): T

        • Parameters

          • Rest ...args: any[]

          Returns T

    Returns function

      • Parameters

        • Rest ...args: any[]

        Returns Promise<T>

reject

  • reject<T>(reason?: any): Promise<T>

  • Returns a promise that is rejected with reason.

    Type parameters

    • T

    Parameters

    • Optional reason: any

    Returns Promise<T>

resolve

  • Calling resolve with a pending promise causes promise to wait on the passed promise, becoming fulfilled with its fulfillment value or rejected with its rejection reason (or staying pending forever, if the passed promise does). Calling resolve with a rejected promise causes promise to be rejected with the passed promise's rejection reason. Calling resolve with a fulfilled promise causes promise to be fulfilled with the passed promise's fulfillment value. Calling resolve with a non-promise value causes promise to be fulfilled with that value.

    Type parameters

    • T

    Parameters

    Returns Promise<T>

  • Calling resolve with a pending promise causes promise to wait on the passed promise, becoming fulfilled with its fulfillment value or rejected with its rejection reason (or staying pending forever, if the passed promise does). Calling resolve with a rejected promise causes promise to be rejected with the passed promise's rejection reason. Calling resolve with a fulfilled promise causes promise to be fulfilled with the passed promise's fulfillment value. Calling resolve with a non-promise value causes promise to be fulfilled with that value.

    Type parameters

    • T

    Parameters

    • object: T

    Returns Promise<T>

send

  • send<T>(obj: any, functionName: string, ...args: any[]): Promise<T>

  • Type parameters

    • T

    Parameters

    • obj: any
    • functionName: string
    • Rest ...args: any[]

    Returns Promise<T>

spread

  • spread<T, U>(promises: IPromise<T>[], onFulfilled: function, onRejected?: function): Promise<U>

  • Like then, but "spreads" the array into a variadic fulfillment handler. If any of the promises in the array are rejected, instead calls onRejected with the first rejected promise's rejection reason. This is especially useful in conjunction with all.

    Type parameters

    • T

    • U

    Parameters

    • promises: IPromise<T>[]
    • onFulfilled: function

        • Parameters

          • Rest ...args: T[]

          Returns U | IPromise<U>

    • Optional onRejected: function

    Returns Promise<U>

timeout

  • timeout<T>(promise: Promise<T>, ms: number, message?: string): Promise<T>

  • Returns a promise that will have the same result as promise, except that if promise is not fulfilled or rejected before ms milliseconds, the returned promise will be rejected with an Error with the given message. If message is not supplied, the message will be "Timed out after " + ms + " ms".

    Type parameters

    • T

    Parameters

    • promise: Promise<T>
    • ms: number
    • Optional message: string

    Returns Promise<T>

when

  • Returns Promise<void>

  • Type parameters

    • T

    Parameters

    Returns Promise<T>

  • Type parameters

    • T

    • U

    Parameters

    • value: T | IPromise<T>
    • onFulfilled: function
    • Optional onRejected: function
    • Optional onProgress: function
        • (progress: any): any

        • Parameters

          • progress: any

          Returns any

    Returns Promise<U>

"typings/main/ambient/chai/index.d"

"typings/main/ambient/chai/index.d":

"chai"

"chai":

Export assignment chai

chai:

AssertionError

AssertionError:

constructor

  • new AssertionError(message: string, _props?: any, ssf?: Function): AssertionError

  • Parameters

    • message: string
    • Optional _props: any
    • Optional ssf: Function

    Returns AssertionError

message

message: string

name

name: string

showDiff

showDiff: boolean

stack

stack: string

Assert

  • __call(express: any, msg?: string): void

  • Parameters

    • express: any
    • Optional msg: string

    Returns void

Throw

  • Throw(fn: Function, msg?: string): void
  • Throw(fn: Function, regExp: RegExp): void
  • Throw(fn: Function, errType: Function, msg?: string): void
  • Throw(fn: Function, errType: Function, regExp: RegExp): void

  • Parameters

    • fn: Function
    • Optional msg: string

    Returns void

  • Parameters

    • fn: Function
    • regExp: RegExp

    Returns void

  • Parameters

    • fn: Function
    • errType: Function
    • Optional msg: string

    Returns void

  • Parameters

    • fn: Function
    • errType: Function
    • regExp: RegExp

    Returns void

closeTo

  • closeTo(act: number, exp: number, delta: number, msg?: string): void

  • Parameters

    • act: number
    • exp: number
    • delta: number
    • Optional msg: string

    Returns void

deepEqual

  • deepEqual(act: any, exp: any, msg?: string): void

  • Parameters

    • act: any
    • exp: any
    • Optional msg: string

    Returns void

deepProperty

  • deepProperty(obj: Object, prop: string, msg?: string): void

  • Parameters

    • obj: Object
    • prop: string
    • Optional msg: string

    Returns void

deepPropertyNotVal

  • deepPropertyNotVal(obj: Object, prop: string, val: any, msg?: string): void

  • Parameters

    • obj: Object
    • prop: string
    • val: any
    • Optional msg: string

    Returns void

deepPropertyVal

  • deepPropertyVal(obj: Object, prop: string, val: any, msg?: string): void

  • Parameters

    • obj: Object
    • prop: string
    • val: any
    • Optional msg: string

    Returns void

doesNotThrow

  • doesNotThrow(fn: Function, msg?: string): void
  • doesNotThrow(fn: Function, regExp: RegExp): void
  • doesNotThrow(fn: Function, errType: Function, msg?: string): void
  • doesNotThrow(fn: Function, errType: Function, regExp: RegExp): void

  • Parameters

    • fn: Function
    • Optional msg: string

    Returns void

  • Parameters

    • fn: Function
    • regExp: RegExp

    Returns void

  • Parameters

    • fn: Function
    • errType: Function
    • Optional msg: string

    Returns void

  • Parameters

    • fn: Function
    • errType: Function
    • regExp: RegExp

    Returns void

equal

  • equal(act: any, exp: any, msg?: string): void

  • Parameters

    • act: any
    • exp: any
    • Optional msg: string

    Returns void

fail

  • fail(actual?: any, expected?: any, msg?: string, operator?: string): void

  • Parameters

    • Optional actual: any
    • Optional expected: any
    • Optional msg: string
    • Optional operator: string

    Returns void

ifError

  • ifError(val: any, msg?: string): void

  • Parameters

    • val: any
    • Optional msg: string

    Returns void

include

  • include(exp: string, inc: any, msg?: string): void
  • include(exp: any[], inc: any, msg?: string): void

  • Parameters

    • exp: string
    • inc: any
    • Optional msg: string

    Returns void

  • Parameters

    • exp: any[]
    • inc: any
    • Optional msg: string

    Returns void

includeMembers

  • includeMembers(set1: any[], set2: any[], msg?: string): void

  • Parameters

    • set1: any[]
    • set2: any[]
    • Optional msg: string

    Returns void

instanceOf

  • instanceOf(val: any, type: Function, msg?: string): void

  • Parameters

    • val: any
    • type: Function
    • Optional msg: string

    Returns void

isArray

  • isArray(val: any, msg?: string): void

  • Parameters

    • val: any
    • Optional msg: string

    Returns void

isBoolean

  • isBoolean(val: any, msg?: string): void

  • Parameters

    • val: any
    • Optional msg: string

    Returns void

isDefined

  • isDefined(val: any, msg?: string): void

  • Parameters

    • val: any
    • Optional msg: string

    Returns void

isFalse

  • isFalse(val: any, msg?: string): void

  • Parameters

    • val: any
    • Optional msg: string

    Returns void

isFunction

  • isFunction(val: any, msg?: string): void

  • Parameters

    • val: any
    • Optional msg: string

    Returns void

isNotArray

  • isNotArray(val: any, msg?: string): void

  • Parameters

    • val: any
    • Optional msg: string

    Returns void

isNotBoolean

  • isNotBoolean(val: any, msg?: string): void

  • Parameters

    • val: any
    • Optional msg: string

    Returns void

isNotFunction

  • isNotFunction(val: any, msg?: string): void

  • Parameters

    • val: any
    • Optional msg: string

    Returns void

isNotNull

  • isNotNull(val: any, msg?: string): void

  • Parameters

    • val: any
    • Optional msg: string

    Returns void

isNotNumber

  • isNotNumber(val: any, msg?: string): void

  • Parameters

    • val: any
    • Optional msg: string

    Returns void

isNotObject

  • isNotObject(val: any, msg?: string): void

  • Parameters

    • val: any
    • Optional msg: string

    Returns void

isNotString

  • isNotString(val: any, msg?: string): void

  • Parameters

    • val: any
    • Optional msg: string

    Returns void

isNull

  • isNull(val: any, msg?: string): void

  • Parameters

    • val: any
    • Optional msg: string

    Returns void

isNumber

  • isNumber(val: any, msg?: string): void

  • Parameters

    • val: any
    • Optional msg: string

    Returns void

isObject

  • isObject(val: any, msg?: string): void

  • Parameters

    • val: any
    • Optional msg: string

    Returns void

isString

  • isString(val: any, msg?: string): void

  • Parameters

    • val: any
    • Optional msg: string

    Returns void

isTrue

  • isTrue(val: any, msg?: string): void

  • Parameters

    • val: any
    • Optional msg: string

    Returns void

isUndefined

  • isUndefined(val: any, msg?: string): void

  • Parameters

    • val: any
    • Optional msg: string

    Returns void

lengthOf

  • lengthOf(exp: any, len: number, msg?: string): void

  • Parameters

    • exp: any
    • len: number
    • Optional msg: string

    Returns void

match

  • match(exp: any, re: RegExp, msg?: string): void

  • Parameters

    • exp: any
    • re: RegExp
    • Optional msg: string

    Returns void

notDeepEqual

  • notDeepEqual(act: any, exp: any, msg?: string): void

  • Parameters

    • act: any
    • exp: any
    • Optional msg: string

    Returns void

notDeepProperty

  • notDeepProperty(obj: Object, prop: string, msg?: string): void

  • Parameters

    • obj: Object
    • prop: string
    • Optional msg: string

    Returns void

notEqual

  • notEqual(act: any, exp: any, msg?: string): void

  • Parameters

    • act: any
    • exp: any
    • Optional msg: string

    Returns void

notInclude

  • notInclude(exp: string, inc: any, msg?: string): void
  • notInclude(exp: any[], inc: any, msg?: string): void

  • Parameters

    • exp: string
    • inc: any
    • Optional msg: string

    Returns void

  • Parameters

    • exp: any[]
    • inc: any
    • Optional msg: string

    Returns void

notInstanceOf

  • notInstanceOf(val: any, type: Function, msg?: string): void

  • Parameters

    • val: any
    • type: Function
    • Optional msg: string

    Returns void

notMatch

  • notMatch(exp: any, re: RegExp, msg?: string): void

  • Parameters

    • exp: any
    • re: RegExp
    • Optional msg: string

    Returns void

notOk

  • notOk(val: any, msg?: string): void

  • Parameters

    • val: any
    • Optional msg: string

    Returns void

notProperty

  • notProperty(obj: Object, prop: string, msg?: string): void

  • Parameters

    • obj: Object
    • prop: string
    • Optional msg: string

    Returns void

notStrictEqual

  • notStrictEqual(act: any, exp: any, msg?: string): void

  • Parameters

    • act: any
    • exp: any
    • Optional msg: string

    Returns void

notTypeOf

  • notTypeOf(val: any, type: string, msg?: string): void

  • Parameters

    • val: any
    • type: string
    • Optional msg: string

    Returns void

ok

  • ok(val: any, msg?: string): void

  • Parameters

    • val: any
    • Optional msg: string

    Returns void

operator

  • operator(val: any, operator: string, val2: any, msg?: string): void

  • Parameters

    • val: any
    • operator: string
    • val2: any
    • Optional msg: string

    Returns void

property

  • property(obj: Object, prop: string, msg?: string): void

  • Parameters

    • obj: Object
    • prop: string
    • Optional msg: string

    Returns void

propertyNotVal

  • propertyNotVal(obj: Object, prop: string, val: any, msg?: string): void

  • Parameters

    • obj: Object
    • prop: string
    • val: any
    • Optional msg: string

    Returns void

propertyVal

  • propertyVal(obj: Object, prop: string, val: any, msg?: string): void

  • Parameters

    • obj: Object
    • prop: string
    • val: any
    • Optional msg: string

    Returns void

sameMembers

  • sameMembers(set1: any[], set2: any[], msg?: string): void

  • Parameters

    • set1: any[]
    • set2: any[]
    • Optional msg: string

    Returns void

strictEqual

  • strictEqual(act: any, exp: any, msg?: string): void

  • Parameters

    • act: any
    • exp: any
    • Optional msg: string

    Returns void

throw

  • throw(fn: Function, msg?: string): void
  • throw(fn: Function, regExp: RegExp): void
  • throw(fn: Function, errType: Function, msg?: string): void
  • throw(fn: Function, errType: Function, regExp: RegExp): void

  • Parameters

    • fn: Function
    • Optional msg: string

    Returns void

  • Parameters

    • fn: Function
    • regExp: RegExp

    Returns void

  • Parameters

    • fn: Function
    • errType: Function
    • Optional msg: string

    Returns void

  • Parameters

    • fn: Function
    • errType: Function
    • regExp: RegExp

    Returns void

throws

  • throws(fn: Function, msg?: string): void
  • throws(fn: Function, regExp: RegExp): void
  • throws(fn: Function, errType: Function, msg?: string): void
  • throws(fn: Function, errType: Function, regExp: RegExp): void

  • Parameters

    • fn: Function
    • Optional msg: string

    Returns void

  • Parameters

    • fn: Function
    • regExp: RegExp

    Returns void

  • Parameters

    • fn: Function
    • errType: Function
    • Optional msg: string

    Returns void

  • Parameters

    • fn: Function
    • errType: Function
    • regExp: RegExp

    Returns void

typeOf

  • typeOf(val: any, type: string, msg?: string): void

  • Parameters

    • val: any
    • type: string
    • Optional msg: string

    Returns void

Assertions

Assertions:

checked

checked: any

disabled

disabled: any

empty

empty: any

exist

exist: any

hidden

hidden: any

selected

selected: any

visible

visible: any

attr

  • attr(name: string, value?: string): any

  • Parameters

    • name: string
    • Optional value: string

    Returns any

class

  • class(className: string): any

  • Parameters

    • className: string

    Returns any

css

  • css(name: string, value?: string): any

  • Parameters

    • name: string
    • Optional value: string

    Returns any

data

  • data(name: string, value?: string): any

  • Parameters

    • name: string
    • Optional value: string

    Returns any

html

  • html(html: string): any

  • Parameters

    • html: string

    Returns any

id

  • id(id: string): any

  • Parameters

    • id: string

    Returns any

text

  • text(text: string): any

  • Parameters

    • text: string

    Returns any

value

  • value(value: string): any

  • Parameters

    • value: string

    Returns any

Config

Config:

includeStack

includeStack: boolean

Deep

Deep:

equal

equal: Equal

property

property: Property

Equal

  • __call(value: any, message?: string): Expect

  • Parameters

    • value: any
    • Optional message: string

    Returns Expect

Expect

  • __call(type: string, message?: string): Expect

  • Parameters

    • type: string
    • Optional message: string

    Returns Expect

Arguments

Arguments: Expect

Throw

Throw: Throw

a

a: TypeComparison

above

above: NumberComparer

an

an: TypeComparison

and

and: Expect

arguments

arguments: Expect

at

at: Expect

be

be: Expect

been

been: Expect

below

below: NumberComparer

checked

checked: any

contain

contain: Include

deep

deep: Deep

disabled

disabled: any

empty

empty: Expect

eq

eq: Equal

eql

eql: Equal

eqls

eqls: Equal

equal

equal: Equal

equals

equals: Equal

exist

exist: Expect

false

false: Expect

greaterThan

greaterThan: NumberComparer

gt

gt: NumberComparer

gte

gte: NumberComparer

has

has: Expect

have

have: Expect

haveOwnProperty

haveOwnProperty: OwnProperty

hidden

hidden: any

include

include: Include

instanceOf

instanceOf: InstanceOf

instanceof

instanceof: InstanceOf

is

is: Expect

itself

itself: Expect

keys

keys: Keys

least

least: NumberComparer

length

length: Length

lengthOf

lengthOf: Length

lessThan

lessThan: NumberComparer

lt

lt: NumberComparer

lte

lte: NumberComparer

members

members: Members

most

most: NumberComparer

not

not: Expect

null

null: Expect

of

of: Expect

ok

ok: Expect

ownProperty

ownProperty: OwnProperty

property

property: Property

same

same: Expect

selected

selected: any

that

that: Expect

throw

throw: Throw

throws

throws: Throw

to

to: Expect

true

true: Expect

undefined

undefined: Expect

visible

visible: any

which

which: Expect

with

with: Expect

attr

  • attr(name: string, value?: string): any

  • Parameters

    • name: string
    • Optional value: string

    Returns any

class

  • class(className: string): any

  • Parameters

    • className: string

    Returns any

closeTo

  • closeTo(expected: number, delta: number, message?: string): Expect

  • Parameters

    • expected: number
    • delta: number
    • Optional message: string

    Returns Expect

css

  • css(name: string, value?: string): any

  • Parameters

    • name: string
    • Optional value: string

    Returns any

data

  • data(name: string, value?: string): any

  • Parameters

    • name: string
    • Optional value: string

    Returns any

html

  • html(html: string): any

  • Parameters

    • html: string

    Returns any

id

  • id(id: string): any

  • Parameters

    • id: string

    Returns any

key

  • Parameters

    • string: string

    Returns Expect

match

  • match(RegularExpression: RegExp, message?: string): Expect

  • Parameters

    • RegularExpression: RegExp
    • Optional message: string

    Returns Expect

respondTo

  • respondTo(method: string, message?: string): Expect

  • Parameters

    • method: string
    • Optional message: string

    Returns Expect

satisfy

  • satisfy(matcher: Function, message?: string): Expect

  • Parameters

    • matcher: Function
    • Optional message: string

    Returns Expect

string

  • string(string: string, message?: string): Expect

  • Parameters

    • string: string
    • Optional message: string

    Returns Expect

text

  • text(text: string): any

  • Parameters

    • text: string

    Returns any

value

  • value(value: string): any

  • Parameters

    • value: string

    Returns any

within

  • within(start: number, finish: number, message?: string): Expect

  • Parameters

    • start: number
    • finish: number
    • Optional message: string

    Returns Expect

ExpectStatic

  • Parameters

    • target: any

    Returns Expect

Include

  • __call(value: Object, message?: string): Expect
  • __call(value: string, message?: string): Expect
  • __call(value: number, message?: string): Expect

  • Parameters

    • value: Object
    • Optional message: string

    Returns Expect

  • Parameters

    • value: string
    • Optional message: string

    Returns Expect

  • Parameters

    • value: number
    • Optional message: string

    Returns Expect

keys

keys: Keys

members

members: Members

InstanceOf

  • __call(constructor: Object, message?: string): Expect

  • Parameters

    • constructor: Object
    • Optional message: string

    Returns Expect

Keys

  • __call(...keys: string[]): Expect
  • __call(keys: any[]): Expect

  • Parameters

    • Rest ...keys: string[]

    Returns Expect

  • Parameters

    • keys: any[]

    Returns Expect

LanguageChains

LanguageChains:

and

and: Expect

at

at: Expect

be

be: Expect

been

been: Expect

has

has: Expect

have

have: Expect

is

is: Expect

of

of: Expect

same

same: Expect

that

that: Expect

to

to: Expect

which

which: Expect

with

with: Expect

Length

  • __call(length: number, message?: string): Expect

  • Parameters

    • length: number
    • Optional message: string

    Returns Expect

above

above: NumberComparer

and

and: Expect

at

at: Expect

be

be: Expect

been

been: Expect

below

below: NumberComparer

greaterThan

greaterThan: NumberComparer

gt

gt: NumberComparer

gte

gte: NumberComparer

has

has: Expect

have

have: Expect

is

is: Expect

least

least: NumberComparer

lessThan

lessThan: NumberComparer

lt

lt: NumberComparer

lte

lte: NumberComparer

most

most: NumberComparer

of

of: Expect

same

same: Expect

that

that: Expect

to

to: Expect

which

which: Expect

with

with: Expect

within

  • within(start: number, finish: number, message?: string): Expect

  • Parameters

    • start: number
    • finish: number
    • Optional message: string

    Returns Expect

Members

  • __call(set: any[], message?: string): Expect

  • Parameters

    • set: any[]
    • Optional message: string

    Returns Expect

NumberComparer

  • __call(value: number, message?: string): Expect

  • Parameters

    • value: number
    • Optional message: string

    Returns Expect

NumericComparison

NumericComparison:

above

above: NumberComparer

below

below: NumberComparer

greaterThan

greaterThan: NumberComparer

gt

gt: NumberComparer

gte

gte: NumberComparer

least

least: NumberComparer

lessThan

lessThan: NumberComparer

lt

lt: NumberComparer

lte

lte: NumberComparer

most

most: NumberComparer

within

  • within(start: number, finish: number, message?: string): Expect

  • Parameters

    • start: number
    • finish: number
    • Optional message: string

    Returns Expect

OwnProperty

  • __call(name: string, message?: string): Expect

  • Parameters

    • name: string
    • Optional message: string

    Returns Expect

Property

  • __call(name: string, value?: any, message?: string): Expect

  • Parameters

    • name: string
    • Optional value: any
    • Optional message: string

    Returns Expect

Throw

  • __call(): Expect
  • __call(expected: string, message?: string): Expect
  • __call(expected: RegExp, message?: string): Expect
  • __call(constructor: Error, expected?: string, message?: string): Expect
  • __call(constructor: Error, expected?: RegExp, message?: string): Expect
  • __call(constructor: Function, expected?: string, message?: string): Expect
  • __call(constructor: Function, expected?: RegExp, message?: string): Expect

  • Returns Expect

  • Parameters

    • expected: string
    • Optional message: string

    Returns Expect

  • Parameters

    • expected: RegExp
    • Optional message: string

    Returns Expect

  • Parameters

    • constructor: Error
    • Optional expected: string
    • Optional message: string

    Returns Expect

  • Parameters

    • constructor: Error
    • Optional expected: RegExp
    • Optional message: string

    Returns Expect

  • Parameters

    • constructor: Function
    • Optional expected: string
    • Optional message: string

    Returns Expect

  • Parameters

    • constructor: Function
    • Optional expected: RegExp
    • Optional message: string

    Returns Expect

TypeComparison

  • __call(type: string, message?: string): Expect

  • Parameters

    • type: string
    • Optional message: string

    Returns Expect

instanceOf

instanceOf: InstanceOf

instanceof

instanceof: InstanceOf

assert

assert: Assert

config

config: Config

expect

  • expect(target: any, message?: string): Expect

  • Parameters

    • target: any
    • Optional message: string

    Returns Expect

use

  • use(fn: function): any

  • Parameters

    • fn: function
        • (chai: any, utils: any): void

        • Parameters

          • chai: any
          • utils: any

          Returns void

    Returns any

"typings/main/ambient/es6-promise/index.d"

"typings/main/ambient/es6-promise/index.d":

"es6-promise"

"es6-promise":

Export assignment rsvp

rsvp:

Promise

Promise: Promise

foo

foo: Promise

Promise

Promise:

constructor

  • new Promise(callback: function): Promise

  • If you call resolve in the body of the callback passed to the constructor, your promise is fulfilled with result object passed to resolve. If you call reject your promise is rejected with the object passed to resolve. For consistency and debugging (eg stack traces), obj should be an instanceof Error. Any errors thrown in the constructor callback will be implicitly passed to reject().

    Parameters

    • callback: function
        • (resolve: function, reject: function): void

        • Parameters

          • resolve: function

              • Parameters

                Returns void

          • reject: function
              • (error?: any): void

              • Parameters

                • Optional error: any

                Returns void

          Returns void

    Returns Promise

catch

  • catch<U>(onRejected?: function): Promise<U>

  • Sugar for promise.then(undefined, onRejected)

    Type parameters

    • U

    Parameters

    • Optional onRejected: function

      called when/if "promise" rejects

    Returns Promise<U>

then

  • then<U>(onFulfilled?: function, onRejected?: function): Promise<U>

  • onFulfilled is called when/if "promise" resolves. onRejected is called when/if "promise" rejects. Both are optional, if either/both are omitted the next onFulfilled/onRejected in the chain is called. Both callbacks have a single parameter , the fulfillment value or rejection reason. "then" returns a new promise equivalent to the value you return from onFulfilled/onRejected after being passed through Promise.resolve. If an error is thrown in the callback, the returned promise rejects with that error.

    Type parameters

    • U

    Parameters

    • Optional onFulfilled: function

      called when/if "promise" resolves

    • Optional onRejected: function

      called when/if "promise" rejects

    Returns Promise<U>

Static all

  • Make a promise that fulfills when every item in the array fulfills, and rejects if (and when) any item rejects. the array passed to all can be a mixture of promise-like objects and other objects. The fulfillment value is an array (in order) of fulfillment values. The rejection value is the first rejection value.

    Type parameters

    • R

    Parameters

    Returns Promise<R[]>

Static race

  • Make a Promise that fulfills when any item fulfills, and rejects if any item rejects.

    Type parameters

    • R

    Parameters

    Returns Promise<R>

Static reject

  • Make a promise that rejects to obj. For consistency and debugging (eg stack traces), obj should be an instanceof Error

    Parameters

    • error: any

    Returns Promise<any>

Static resolve

  • Make a new promise from the thenable. A thenable is promise-like in as far as it has a "then" method.

    Type parameters

    • R

    Parameters

    Returns Promise<R>

Thenable

Thenable:

then

  • then<U>(onFulfilled?: function, onRejected?: function): Thenable<U>

  • Type parameters

    • U

    Parameters

    • Optional onFulfilled: function
    • Optional onRejected: function

    Returns Thenable<U>

"typings/main/ambient/har/index.d"

"typings/main/ambient/har/index.d":

har

har:

Definitions for HAR 1.2 ( Http Archive Format ) http://www.softwareishard.com/blog/har-12-spec/

Browser

Browser:

Optional comment

comment: string

Optional name

name: string

Optional version

version: string

Cache

Cache:

Optional afterRequest

afterRequest: CacheEntry

Optional beforeRequest

beforeRequest: CacheEntry

Optional comment

comment: string

CacheEntry

CacheEntry:

Optional comment

comment: string

Optional eTag

eTag: string

Optional expires

expires: ISO8601TimeString

Expiration time of the cache entry.

Optional hitCount

hitCount: number

The number of times the cache entry has been opened.

Optional lastAccess

lastAccess: ISO8601TimeString

The last time the cache entry was opened.

Commentable

Commentable:

Optional comment

comment: string

Content

Content:

Optional comment

comment: string

Optional compression

compression: number

Number of bytes saved. Leave out this field if the information is not available.

Optional encoding

encoding: string

Encoding used for response text field e.g "base64". Leave out this field if the text field is HTTP decoded (decompressed & unchunked), than trans-coded from its original character set into UTF-8.

Optional mimeType

mimeType: string

MIME type of the response text (value of the Content-Type response header). The charset attribute of the MIME type is included (if available).

Optional size

size: number

Length of the returned content in bytes. Should be equal to response.bodySize if there is no compression and bigger when the content has been compressed.

Optional text

text: string

Response body sent from the server or loaded from the browser cache. This field is populated with textual content only. The text field is either HTTP decoded text or a encoded (e.g. "base64") representation of the response body. Leave out this field if the information is not available.

Cookie

Cookie:

Optional comment

comment: string

Optional domain

domain: string

The host of the cookie.

Optional expires

expires: ISO8601TimeString

Cookie expiration time. (ISO 8601 - YYYY-MM-DDThh:mm:ss.sTZD, e.g. 2009-07-24T19:20:30.123+02:00).

Optional httpOnly

httpOnly: boolean

Set to true if the cookie is HTTP only, false otherwise.

Optional name

name: string

The name of the cookie.

Optional path

path: string

The path pertaining to the cookie.

Optional secure

secure: boolean

True if the cookie was transmitted over ssl, false otherwise.

Optional value

value: string

The cookie value.

Creator

Creator:

Optional comment

comment: string

Optional name

name: string

Optional version

version: string

Entry

Entry:

This object represents an array with all exported HTTP requests. Sorting entries by startedDateTime (starting from the oldest) is preferred way how to export data since it can make importing faster. However the reader application should always make sure the array is sorted (if required for the import).

Optional cache

cache: Cache

Info about cache usage.

Optional comment

comment: string

Optional connection

connection: string

Unique ID of the parent TCP/IP connection, can be the client or server port number. Note that a port number doesn't have to be unique identifier in cases where the port is shared for more connections. If the port isn't available for the application, any other unique connection ID can be used instead (e.g. connection index). Leave out this field if the application doesn't support this info.

Optional pageref

pageref: string

unique Reference to the parent page. Leave out this field if the application does not support grouping by pages.

Optional request

request: Request

Detailed info about the request.

Optional response

response: Response

Detailed info about the response

Optional serverIPAddress

serverIPAddress: IPAddressString

IP address of the server that was connected (result of DNS resolution).

Optional startedDateTime

startedDateTime: ISO8601TimeString

Date and time stamp of the request start (ISO 8601 - YYYY-MM-DDThh:mm:ss.sTZD).

Optional time

time: number

Total elapsed time of the request in milliseconds. This is the sum of all timings available in the timings object (i.e. not including -1 values)

Optional timings

timings: EntryTiming

Detailed timing info about request/response round trip.

EntryTiming

EntryTiming:

Optional blocked

blocked: number

Time spent in a queue waiting for a network connection. Use -1 if the timing does not apply to the current request.

Optional connect

connect: number

Time required to create TCP connection. Use -1 if the timing does not apply to the current request.

Optional dns

dns: number

DNS resolution time. The time required to resolve a host name. Use -1 if the timing does not apply to the current request.

Optional receive

receive: number

Time required to read entire response from the server (or cache).

Optional send

send: number

Time required to send HTTP request to the server.

Optional ssl

ssl: number

Time required for SSL/TLS negotiation. If this field is defined then the time is also included in the connect field (to ensure backward compatibility with HAR 1.1). Use -1 if the timing does not apply to the current request.

Optional wait

wait: number

Waiting for a response from the server.

Header

Header:

Optional comment

comment: string

name

name: string

value

value: string

Log

Log:

Optional browser

browser: Browser

Name and version info of used browser.

Optional comment

comment: string

Optional creator

creator: Creator

Name and version info of the log creator application.

Optional entries

entries: Entry[]

List of all exported (tracked) requests.

Optional pages

pages: Page[]

List of all exported (tracked) pages. Leave out this field if the application does not support grouping by pages

Optional version

version: string

Version number of the format. If empty, string "1.1" is assumed by default.

Page

Page:

Optional comment

comment: string

Optional id

id: string

Unique identifier of a page within the . Entries use it to refer the parent page

Optional pageTimings

pageTimings: PageTiming[]

Detailed timing info about page load.

Optional startedDateTime

startedDateTime: ISO8601TimeString

Date and time stamp for the beginning of the page load (ISO 8601 - YYYY-MM-DDThh:mm:ss.sTZD, e.g. 2009-07-24T19:20:30.45+01:00).

Optional title

title: string

Page title.

PageTiming

PageTiming:

This object describes timings for various events (states) fired during the page load. All times are specified in milliseconds. If a time info is not available appropriate field is set to -1.

Optional onContentLoad

onContentLoad: number

Content of the page loaded. Number of milliseconds since page load started (page.startedDateTime). Use -1 if the timing does not apply to the current request.

Optional onLoad

onLoad: number

Page is loaded (onLoad event fired). Number of milliseconds since page load started (page.startedDateTime). Use -1 if the timing does not apply to the current request.

PostData

PostData:

Optional comment

comment: string

Optional mimeType

mimeType: string

Mime type of posted data.

Optional params

params: PostDataParam[]

List of posted parameters (in case of URL encoded parameters).

Optional text

text: string

Plain text posted data

PostDataParam

PostDataParam:

Optional comment

comment: string

Optional contentType

contentType: string

content type of a posted file

Optional fileName

fileName: string

name of a posted file.

Optional name

name: string

name of a posted parameter.

Optional value

value: string

value of a posted parameter or content of a posted file.

QueryParameter

QueryParameter:

This object contains list of all parameters & values parsed from a query string, if any (embedded in object). HAR format expects NVP (name-value pairs) formatting of the query string.

Optional comment

comment: string

name

name: string

value

value: string

Request

Request:

Optional bodySize

bodySize: number

Size of the request body (POST data payload) in bytes. Set to -1 if the info is not available.

Optional comment

comment: string

Optional cookies

cookies: Cookie[]

List of cookie objects.

Optional headers

headers: Header[]

List of header objects.

Optional headersSize

headersSize: number

Total number of bytes from the start of the HTTP request message until (and including) the double CRLF before the body. Set to -1 if the info is not available.

Optional httpVersion

httpVersion: string

Request HTTP Version.

Optional method

method: string

Request method (GET, POST, ...).

Optional postData

postData: PostData

osted data info.

Optional queryString

queryString: QueryParameter[]

List of query parameter objects.

Optional url

url: string

Absolute URL of the request (fragments are not included).

Response

Response:

Optional bodySize

bodySize: number

Size of the received response body in bytes. Set to zero in case of responses coming from the cache (304). Set to -1 if the info is not available.

Optional comment

comment: string

Optional content

content: Content

Details about the response body.

Optional cookies

cookies: Cookie[]

Optional headers

headers: Header[]

Optional headersSize

headersSize: number

Total number of bytes from the start of the HTTP response message until (and including) the double CRLF before the body. Set to -1 if the info is not available.

The size of received response-headers is computed only from headers that are really received from the server. Additional headers appended by the browser are not included in this number, but they appear in the list of header objects.

The total response size received can be computed as follows (if both values are available):

var totalSize = entry.response.headersSize + entry.response.bodySize;

Optional httpVersion

httpVersion: string

Response HTTP Version.

Optional redirectURL

redirectURL: string

Redirection target URL from the Location response header.

Optional status

status: number

Response status.

Optional statusText

statusText: string

Response status description.

IPAddressString

IPAddressString: string

"10.0.0.1"

ISO8601TimeString

ISO8601TimeString: string

(ISO 8601 - YYYY-MM-DDThh:mm:ss.sTZD, e.g. 2009-07-24T19:20:30.123+02:00).

"typings/main/ambient/invariant/index.d"

"typings/main/ambient/invariant/index.d":

"invariant"

"invariant":

invariant

invariant: function

Type declaration

    • (condition: boolean, message: string, ...args: string[]): void

    • Parameters

      • condition: boolean
      • message: string
      • Rest ...args: string[]

      Returns void

_invariant

_invariant: invariant

"typings/main/ambient/lrucache/index.d"

"typings/main/ambient/lrucache/index.d":

"lrucache"

"lrucache":

CACHE

CACHE:

get

  • get(k: string): any

  • Parameters

    • k: string

    Returns any

set

  • set(k: string, v: any): any

  • Parameters

    • k: string
    • v: any

    Returns any

Export assignment lru

  • lru(num: number): CACHE

  • Parameters

    • num: number

    Returns CACHE

"typings/main/ambient/marked/index.d"

"typings/main/ambient/marked/index.d":

"marked"

"marked":

MarkedOptions

MarkedOptions:

Optional breaks

breaks: boolean

Enable GFM line breaks. This option requires the gfm option to be true.

Optional gfm

gfm: boolean

Enable GitHub flavored markdown.

Optional langPrefix

langPrefix: string

Set the prefix for code block classes.

Optional pedantic

pedantic: boolean

Conform to obscure parts of markdown.pl as much as possible. Don't fix any of the original markdown bugs or poor behavior.

Optional sanitize

sanitize: boolean

Sanitize the output. Ignore any HTML that has been input.

Optional silent

silent: boolean

Shows an HTML error message when rendering fails.

Optional smartLists

smartLists: boolean

Use smarter list behavior than the original markdown. May eventually be default with the old behavior moved into pedantic.

Optional smartypants

smartypants: boolean

Use "smart" typograhic punctuation for things like quotes and dashes.

Optional tables

tables: boolean

Enable GFM tables. This option requires the gfm option to be true.

Optional highlight

  • highlight(code: string, lang: string, callback?: Function): string

  • A function to highlight code blocks. The function takes three arguments: code, lang, and callback.

    Parameters

    • code: string
    • lang: string
    • Optional callback: Function

    Returns string

Export assignment MarkedStatic

  • __call(src: string, callback: Function): string
  • __call(src: string, options?: MarkedOptions, callback?: Function): string

  • Compiles markdown to HTML.

    Parameters

    • src: string

      String of markdown source to be compiled

    • callback: Function

      Function called when the markdownString has been fully parsed when using async highlighting

    Returns string

    String of compiled HTML

  • Compiles markdown to HTML.

    Parameters

    • src: string

      String of markdown source to be compiled

    • Optional options: MarkedOptions

      Hash of options

    • Optional callback: Function

      Function called when the markdownString has been fully parsed when using async highlighting

    Returns string

    String of compiled HTML

lexer

  • Parameters

    • src: string

      String of markdown source to be compiled

    • Optional options: MarkedOptions

      Hash of options

    Returns any[]

parse

  • parse(src: string, callback: Function): string
  • parse(src: string, options?: MarkedOptions, callback?: Function): string

  • Compiles markdown to HTML.

    Parameters

    • src: string

      String of markdown source to be compiled

    • callback: Function

      Function called when the markdownString has been fully parsed when using async highlighting

    Returns string

    String of compiled HTML

  • Compiles markdown to HTML.

    Parameters

    • src: string

      String of markdown source to be compiled

    • Optional options: MarkedOptions

      Hash of options

    • Optional callback: Function

      Function called when the markdownString has been fully parsed when using async highlighting

    Returns string

    String of compiled HTML

parser

  • Parameters

    Returns string

setOptions

  • Sets the default options.

    Parameters

    Returns void

marked

marked: MarkedStatic

"typings/main/ambient/mkdirp/index.d"

"typings/main/ambient/mkdirp/index.d":

"mkdirp"

"mkdirp":

Export assignment mkdirp

  • mkdirp(dir: string, cb: function): void
  • mkdirp(dir: string, flags: any, cb: function): void

  • Parameters

    • dir: string
    • cb: function
        • (err: any, made: string): void

        • Parameters

          • err: any
          • made: string

          Returns void

    Returns void

  • Parameters

    • dir: string
    • flags: any
    • cb: function
        • (err: any, made: string): void

        • Parameters

          • err: any
          • made: string

          Returns void

    Returns void

sync

  • sync(dir: string, flags?: any): string

  • Parameters

    • dir: string
    • Optional flags: any

    Returns string

"typings/main/ambient/mocha/index.d"

"typings/main/ambient/mocha/index.d":

"mocha"

"mocha":

Export assignment Mocha

Mocha:

constructor

  • new Mocha(options?: object): Mocha

  • Parameters

    • Optional options: object
      • Optional bail?: boolean
      • Optional grep?: RegExp
      • Optional reporter?: string
      • Optional timeout?: number
      • Optional ui?: string

    Returns Mocha

addFile

  • addFile(file: string): Mocha

  • Parameters

    • file: string

    Returns Mocha

asyncOnly

  • asyncOnly(value: boolean): Mocha

  • Parameters

    • value: boolean

    Returns Mocha

bail

  • bail(value?: boolean): Mocha

  • Parameters

    • Optional value: boolean

    Returns Mocha

checkLeaks

  • Returns Mocha

enableTimeouts

  • enableTimeouts(value: boolean): Mocha

  • Parameters

    • value: boolean

    Returns Mocha

globals

  • globals(value: string): Mocha
  • globals(values: string[]): Mocha

  • Parameters

    • value: string

    Returns Mocha

  • Parameters

    • values: string[]

    Returns Mocha

grep

  • grep(value: string): Mocha
  • grep(value: RegExp): Mocha

  • Parameters

    • value: string

    Returns Mocha

  • Parameters

    • value: RegExp

    Returns Mocha

growl

  • Returns Mocha

ignoreLeaks

  • ignoreLeaks(value: boolean): Mocha

  • Parameters

    • value: boolean

    Returns Mocha

invert

  • Returns Mocha

noHighlighting

  • noHighlighting(value: boolean): Mocha

  • Parameters

    • value: boolean

    Returns Mocha

reporter

  • reporter(value: string): Mocha

  • Parameters

    • value: string

    Returns Mocha

run

  • run(onComplete?: function): void

  • Parameters

    • Optional onComplete: function
        • (failures: number): void

        • Parameters

          • failures: number

          Returns void

    Returns void

slow

  • slow(value: number): Mocha

  • Parameters

    • value: number

    Returns Mocha

timeout

  • timeout(value: number): Mocha

  • Parameters

    • value: number

    Returns Mocha

ui

  • ui(value: string): Mocha

  • Parameters

    • value: string

    Returns Mocha

useColors

  • useColors(value: boolean): Mocha

  • Parameters

    • value: boolean

    Returns Mocha

useInlineDiffs

  • useInlineDiffs(value: boolean): Mocha

  • Parameters

    • value: boolean

    Returns Mocha

Mocha

Mocha:

growl

  • Returns Mocha

reporter

  • reporter(reporter: function): Mocha
  • reporter(reporter: string): Mocha

  • Parameters

    • reporter: function
        • (): void

        • Returns void

    Returns Mocha

  • Parameters

    • reporter: string

    Returns Mocha

run

  • run(callback?: function): void

  • Parameters

    • Optional callback: function
        • (): void

        • Returns void

    Returns void

setup

MochaDone

  • __call(error?: Error): void

  • Parameters

    • Optional error: Error

    Returns void

MochaSetupOptions

MochaSetupOptions:

Optional bail

bail: Boolean

Optional globals

globals: any[]

Optional grep

grep: any

Optional ignoreLeaks

ignoreLeaks: Boolean

Optional reporter

reporter: any

Optional slow

slow: number

Optional timeout

timeout: number

Optional ui

ui: string

context

context: object

Type declaration

    • (contextTitle: string, spec: function): void

    • Parameters

      • contextTitle: string
      • spec: function
          • (): void

          • Returns void

      Returns void

  • only: function
    • only(contextTitle: string, spec: function): void

    • Parameters

      • contextTitle: string
      • spec: function
          • (): void

          • Returns void

      Returns void

  • skip: function
    • skip(contextTitle: string, spec: function): void

    • Parameters

      • contextTitle: string
      • spec: function
          • (): void

          • Returns void

      Returns void

  • timeout: function
    • timeout(ms: number): void

    • Parameters

      • ms: number

      Returns void

describe

describe: object

Type declaration

    • (description: string, spec: function): void

    • Parameters

      • description: string
      • spec: function
          • (): void

          • Returns void

      Returns void

  • only: function
    • only(description: string, spec: function): void

    • Parameters

      • description: string
      • spec: function
          • (): void

          • Returns void

      Returns void

  • skip: function
    • skip(description: string, spec: function): void

    • Parameters

      • description: string
      • spec: function
          • (): void

          • Returns void

      Returns void

  • timeout: function
    • timeout(ms: number): void

    • Parameters

      • ms: number

      Returns void

it

it: object

Type declaration

    • (expectation: string, assertion?: function): void
    • (expectation: string, assertion?: function): void

    • Parameters

      • expectation: string
      • Optional assertion: function
          • (): void

          • Returns void

      Returns void

    • Parameters

      • expectation: string
      • Optional assertion: function

      Returns void

  • only: function
    • only(expectation: string, assertion?: function): void
    • only(expectation: string, assertion?: function): void

    • Parameters

      • expectation: string
      • Optional assertion: function
          • (): void

          • Returns void

      Returns void

    • Parameters

      • expectation: string
      • Optional assertion: function

      Returns void

  • skip: function
    • skip(expectation: string, assertion?: function): void
    • skip(expectation: string, assertion?: function): void

    • Parameters

      • expectation: string
      • Optional assertion: function
          • (): void

          • Returns void

      Returns void

    • Parameters

      • expectation: string
      • Optional assertion: function

      Returns void

  • timeout: function
    • timeout(ms: number): void

    • Parameters

      • ms: number

      Returns void

mocha

mocha: Mocha

after

  • after(action: function): void
  • after(action: function): void

  • Parameters

    • action: function
        • (): void

        • Returns void

    Returns void

  • Parameters

    Returns void

afterEach

  • afterEach(action: function): void
  • afterEach(action: function): void

  • Parameters

    • action: function
        • (): void

        • Returns void

    Returns void

  • Parameters

    Returns void

before

  • before(action: function): void
  • before(action: function): void

  • Parameters

    • action: function
        • (): void

        • Returns void

    Returns void

  • Parameters

    Returns void

beforeEach

  • beforeEach(action: function): void
  • beforeEach(action: function): void

  • Parameters

    • action: function
        • (): void

        • Returns void

    Returns void

  • Parameters

    Returns void

setup

  • setup(action: function): void
  • setup(action: function): void

  • Parameters

    • action: function
        • (): void

        • Returns void

    Returns void

  • Parameters

    Returns void

suiteSetup

  • suiteSetup(action: function): void
  • suiteSetup(action: function): void

  • Parameters

    • action: function
        • (): void

        • Returns void

    Returns void

  • Parameters

    Returns void

suiteTeardown

  • suiteTeardown(action: function): void
  • suiteTeardown(action: function): void

  • Parameters

    • action: function
        • (): void

        • Returns void

    Returns void

  • Parameters

    Returns void

teardown

  • teardown(action: function): void
  • teardown(action: function): void

  • Parameters

    • action: function
        • (): void

        • Returns void

    Returns void

  • Parameters

    Returns void

"typings/main/ambient/node/index.d"

"typings/main/ambient/node/index.d": 
                                          *
          Node.js v0.12.0 API             *
                                          *

"assert"

"assert":

Export assignment internal

  • internal(value: any, message?: string): void

  • Parameters

    • value: any
    • Optional message: string

    Returns void

AssertionError

AssertionError:

constructor

  • Parameters

    • Optional options: object
      • Optional actual?: any
      • Optional expected?: any
      • Optional message?: string
      • Optional operator?: string
      • Optional stackStartFunction?: Function

    Returns AssertionError

actual

actual: any

expected

expected: any

generatedMessage

generatedMessage: boolean

message

message: string

name

name: string

operator

operator: string

doesNotThrow

doesNotThrow: function

Type declaration

    • (block: Function, message?: string): void
    • (block: Function, error: Function, message?: string): void
    • (block: Function, error: RegExp, message?: string): void
    • (block: Function, error: function, message?: string): void

    • Parameters

      • block: Function
      • Optional message: string

      Returns void

    • Parameters

      • block: Function
      • error: Function
      • Optional message: string

      Returns void

    • Parameters

      • block: Function
      • error: RegExp
      • Optional message: string

      Returns void

    • Parameters

      • block: Function
      • error: function
          • (err: any): boolean

          • Parameters

            • err: any

            Returns boolean

      • Optional message: string

      Returns void

throws

throws: function

Type declaration

    • (block: Function, message?: string): void
    • (block: Function, error: Function, message?: string): void
    • (block: Function, error: RegExp, message?: string): void
    • (block: Function, error: function, message?: string): void

    • Parameters

      • block: Function
      • Optional message: string

      Returns void

    • Parameters

      • block: Function
      • error: Function
      • Optional message: string

      Returns void

    • Parameters

      • block: Function
      • error: RegExp
      • Optional message: string

      Returns void

    • Parameters

      • block: Function
      • error: function
          • (err: any): boolean

          • Parameters

            • err: any

            Returns boolean

      • Optional message: string

      Returns void

deepEqual

  • deepEqual(actual: any, expected: any, message?: string): void

  • Parameters

    • actual: any
    • expected: any
    • Optional message: string

    Returns void

equal

  • equal(actual: any, expected: any, message?: string): void

  • Parameters

    • actual: any
    • expected: any
    • Optional message: string

    Returns void

fail

  • fail(actual?: any, expected?: any, message?: string, operator?: string): void

  • Parameters

    • Optional actual: any
    • Optional expected: any
    • Optional message: string
    • Optional operator: string

    Returns void

ifError

  • ifError(value: any): void

  • Parameters

    • value: any

    Returns void

notDeepEqual

  • notDeepEqual(acutal: any, expected: any, message?: string): void

  • Parameters

    • acutal: any
    • expected: any
    • Optional message: string

    Returns void

notEqual

  • notEqual(actual: any, expected: any, message?: string): void

  • Parameters

    • actual: any
    • expected: any
    • Optional message: string

    Returns void

notStrictEqual

  • notStrictEqual(actual: any, expected: any, message?: string): void

  • Parameters

    • actual: any
    • expected: any
    • Optional message: string

    Returns void

ok

  • ok(value: any, message?: string): void

  • Parameters

    • value: any
    • Optional message: string

    Returns void

strictEqual

  • strictEqual(actual: any, expected: any, message?: string): void

  • Parameters

    • actual: any
    • expected: any
    • Optional message: string

    Returns void

"buffer"

"buffer": 
                                          *
              MODULES                     *
                                          *

INSPECT_MAX_BYTES

INSPECT_MAX_BYTES: number

"child_process"

"child_process":

ChildProcess

ChildProcess:

pid

pid: number

stderr

stderr: Readable

stdin

stdin: Writable

stdout

stdout: Readable

addListener

  • addListener(event: string, listener: Function): EventEmitter

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

disconnect

  • disconnect(): void

  • Returns void

emit

  • emit(event: string, ...args: any[]): boolean

  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

kill

  • kill(signal?: string): void

  • Parameters

    • Optional signal: string

    Returns void

listeners

  • listeners(event: string): Function[]

  • Parameters

    • event: string

    Returns Function[]

on

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

once

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

removeAllListeners

  • Parameters

    • Optional event: string

    Returns EventEmitter

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

send

  • send(message: any, sendHandle?: any): void

  • Parameters

    • message: any
    • Optional sendHandle: any

    Returns void

setMaxListeners

  • setMaxListeners(n: number): void

  • Parameters

    • n: number

    Returns void

Static listenerCount

  • listenerCount(emitter: EventEmitter, event: string): number

  • Parameters

    Returns number

exec

  • exec(command: string, options: object, callback: function): ChildProcess
  • exec(command: string, callback: function): ChildProcess

  • Parameters

    • command: string
    • options: object
      • Optional customFds?: any
      • Optional cwd?: string
      • Optional encoding?: string
      • Optional env?: any
      • Optional killSignal?: string
      • Optional maxBuffer?: number
      • Optional stdio?: any
      • Optional timeout?: number
    • callback: function

        • Parameters

          Returns void

    Returns ChildProcess

  • Parameters

    • command: string
    • callback: function

        • Parameters

          Returns void

    Returns ChildProcess

execFile

  • execFile(file: string, callback?: function): ChildProcess
  • execFile(file: string, args?: string[], callback?: function): ChildProcess
  • execFile(file: string, args?: string[], options?: object, callback?: function): ChildProcess

  • Parameters

    • file: string
    • Optional callback: function

        • Parameters

          Returns void

    Returns ChildProcess

  • Parameters

    • file: string
    • Optional args: string[]
    • Optional callback: function

        • Parameters

          Returns void

    Returns ChildProcess

  • Parameters

    • file: string
    • Optional args: string[]
    • Optional options: object
      • Optional customFds?: any
      • Optional cwd?: string
      • Optional encoding?: string
      • Optional env?: any
      • Optional killSignal?: string
      • Optional maxBuffer?: string
      • Optional stdio?: any
      • Optional timeout?: number
    • Optional callback: function

        • Parameters

          Returns void

    Returns ChildProcess

execSync

  • Parameters

    • command: string
    • Optional options: object
      • Optional cwd?: string
      • Optional encoding?: string
      • Optional env?: any
      • Optional gid?: number
      • Optional input?: string | Buffer
      • Optional killSignal?: string
      • Optional maxBuffer?: number
      • Optional stdio?: any
      • Optional timeout?: number
      • Optional uid?: number

    Returns ChildProcess

fork

  • fork(modulePath: string, args?: string[], options?: object): ChildProcess

  • Parameters

    • modulePath: string
    • Optional args: string[]
    • Optional options: object
      • Optional cwd?: string
      • Optional encoding?: string
      • Optional env?: any

    Returns ChildProcess

spawn

  • spawn(command: string, args?: string[], options?: object): ChildProcess

  • Parameters

    • command: string
    • Optional args: string[]
    • Optional options: object
      • Optional custom?: any
      • Optional cwd?: string
      • Optional detached?: boolean
      • Optional env?: any
      • Optional stdio?: any

    Returns ChildProcess

"cluster"

"cluster":

Worker

Worker:

id

id: string

process

process: ChildProcess

suicide

suicide: boolean

addListener

  • addListener(event: string, listener: Function): EventEmitter

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

destroy

  • destroy(signal?: string): void

  • Parameters

    • Optional signal: string

    Returns void

disconnect

  • disconnect(): void

  • Returns void

emit

  • emit(event: string, ...args: any[]): boolean

  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

kill

  • kill(signal?: string): void

  • Parameters

    • Optional signal: string

    Returns void

listeners

  • listeners(event: string): Function[]

  • Parameters

    • event: string

    Returns Function[]

on

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

once

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

removeAllListeners

  • Parameters

    • Optional event: string

    Returns EventEmitter

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

send

  • send(message: any, sendHandle?: any): void

  • Parameters

    • message: any
    • Optional sendHandle: any

    Returns void

setMaxListeners

  • setMaxListeners(n: number): void

  • Parameters

    • n: number

    Returns void

Static listenerCount

  • listenerCount(emitter: EventEmitter, event: string): number

  • Parameters

    Returns number

ClusterSettings

ClusterSettings:

Optional args

args: string[]

Optional exec

exec: string

Optional silent

silent: boolean

isMaster

isMaster: boolean

isWorker

isWorker: boolean

settings

settings: ClusterSettings

worker

worker: Worker

workers

workers: Worker[]

addListener

  • addListener(event: string, listener: Function): void

  • Parameters

    • event: string
    • listener: Function

    Returns void

disconnect

  • disconnect(callback?: Function): void

  • Parameters

    • Optional callback: Function

    Returns void

emit

  • emit(event: string, ...args: any[]): boolean

  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

fork

  • Parameters

    • Optional env: any

    Returns Worker

listeners

  • listeners(event: string): Function[]

  • Parameters

    • event: string

    Returns Function[]

on

  • on(event: string, listener: Function): any

  • Parameters

    • event: string
    • listener: Function

    Returns any

once

  • once(event: string, listener: Function): void

  • Parameters

    • event: string
    • listener: Function

    Returns void

removeAllListeners

  • removeAllListeners(event?: string): void

  • Parameters

    • Optional event: string

    Returns void

removeListener

  • removeListener(event: string, listener: Function): void

  • Parameters

    • event: string
    • listener: Function

    Returns void

setMaxListeners

  • setMaxListeners(n: number): void

  • Parameters

    • n: number

    Returns void

setupMaster

  • Parameters

    Returns void

"crypto"

"crypto":

Cipher

Cipher:

final

  • final(): Buffer
  • final(output_encoding: string): string

  • Returns Buffer

  • Parameters

    • output_encoding: string

    Returns string

setAutoPadding

  • setAutoPadding(auto_padding: boolean): void

  • Parameters

    • auto_padding: boolean

    Returns void

update

  • update(data: Buffer): Buffer
  • update(data: string, input_encoding?: string, output_encoding?: string): string

  • Parameters

    Returns Buffer

  • Parameters

    • data: string
    • Optional input_encoding: string
    • Optional output_encoding: string

    Returns string

CredentialDetails

CredentialDetails:

ca

ca: any

cert

cert: string

ciphers

ciphers: string

crl

crl: any

key

key: string

passphrase

passphrase: string

pfx

pfx: string

Credentials

Credentials:

Optional context

context: any

Decipher

Decipher:

final

  • final(): Buffer
  • final(output_encoding: string): string

  • Returns Buffer

  • Parameters

    • output_encoding: string

    Returns string

setAutoPadding

  • setAutoPadding(auto_padding: boolean): void

  • Parameters

    • auto_padding: boolean

    Returns void

update

  • update(data: Buffer): Buffer
  • update(data: string, input_encoding?: string, output_encoding?: string): string

  • Parameters

    Returns Buffer

  • Parameters

    • data: string
    • Optional input_encoding: string
    • Optional output_encoding: string

    Returns string

DiffieHellman

DiffieHellman:

computeSecret

  • computeSecret(other_public_key: string, input_encoding?: string, output_encoding?: string): string

  • Parameters

    • other_public_key: string
    • Optional input_encoding: string
    • Optional output_encoding: string

    Returns string

generateKeys

  • generateKeys(encoding?: string): string

  • Parameters

    • Optional encoding: string

    Returns string

getGenerator

  • getGenerator(encoding: string): string

  • Parameters

    • encoding: string

    Returns string

getPrime

  • getPrime(encoding?: string): string

  • Parameters

    • Optional encoding: string

    Returns string

getPrivateKey

  • getPrivateKey(encoding?: string): string

  • Parameters

    • Optional encoding: string

    Returns string

getPublicKey

  • getPublicKey(encoding?: string): string

  • Parameters

    • Optional encoding: string

    Returns string

setPrivateKey

  • setPrivateKey(public_key: string, encoding?: string): void

  • Parameters

    • public_key: string
    • Optional encoding: string

    Returns void

setPublicKey

  • setPublicKey(public_key: string, encoding?: string): void

  • Parameters

    • public_key: string
    • Optional encoding: string

    Returns void

Hash

Hash:

digest

  • digest(encoding: "buffer"): Buffer
  • digest(encoding: string): any
  • digest(): Buffer

  • Parameters

    • encoding: "buffer"

    Returns Buffer

  • Parameters

    • encoding: string

    Returns any

  • Returns Buffer

update

  • update(data: any, input_encoding?: string): Hash

  • Parameters

    • data: any
    • Optional input_encoding: string

    Returns Hash

Hmac

Hmac:

digest

  • digest(encoding: "buffer"): Buffer
  • digest(encoding: string): any
  • digest(): Buffer

  • Parameters

    • encoding: "buffer"

    Returns Buffer

  • Parameters

    • encoding: string

    Returns any

  • Returns Buffer

update

  • update(data: any, input_encoding?: string): Hmac

  • Parameters

    • data: any
    • Optional input_encoding: string

    Returns Hmac

Signer

Signer:

sign

  • sign(private_key: string, output_format: string): string

  • Parameters

    • private_key: string
    • output_format: string

    Returns string

update

  • update(data: any): void

  • Parameters

    • data: any

    Returns void

Verify

Verify:

update

  • update(data: any): void

  • Parameters

    • data: any

    Returns void

verify

  • verify(object: string, signature: string, signature_format?: string): boolean

  • Parameters

    • object: string
    • signature: string
    • Optional signature_format: string

    Returns boolean

createCipher

  • createCipher(algorithm: string, password: any): Cipher

  • Parameters

    • algorithm: string
    • password: any

    Returns Cipher

createCipheriv

  • createCipheriv(algorithm: string, key: any, iv: any): Cipher

  • Parameters

    • algorithm: string
    • key: any
    • iv: any

    Returns Cipher

createCredentials

createDecipher

  • createDecipher(algorithm: string, password: any): Decipher

  • Parameters

    • algorithm: string
    • password: any

    Returns Decipher

createDecipheriv

  • createDecipheriv(algorithm: string, key: any, iv: any): Decipher

  • Parameters

    • algorithm: string
    • key: any
    • iv: any

    Returns Decipher

createDiffieHellman

  • Parameters

    • prime_length: number

    Returns DiffieHellman

  • Parameters

    • prime: number
    • Optional encoding: string

    Returns DiffieHellman

createHash

  • createHash(algorithm: string): Hash

  • Parameters

    • algorithm: string

    Returns Hash

createHmac

  • createHmac(algorithm: string, key: string): Hmac
  • createHmac(algorithm: string, key: Buffer): Hmac

  • Parameters

    • algorithm: string
    • key: string

    Returns Hmac

  • Parameters

    • algorithm: string
    • key: Buffer

    Returns Hmac

createSign

  • createSign(algorithm: string): Signer

  • Parameters

    • algorithm: string

    Returns Signer

createVerify

  • createVerify(algorith: string): Verify

  • Parameters

    • algorith: string

    Returns Verify

getDiffieHellman

  • Parameters

    • group_name: string

    Returns DiffieHellman

pbkdf2

  • pbkdf2(password: string, salt: string, iterations: number, keylen: number, callback: function): void

  • Parameters

    • password: string
    • salt: string
    • iterations: number
    • keylen: number
    • callback: function
        • (err: Error, derivedKey: Buffer): any

        • Parameters

          • err: Error
          • derivedKey: Buffer

          Returns any

    Returns void

pbkdf2Sync

  • pbkdf2Sync(password: string, salt: string, iterations: number, keylen: number): Buffer

  • Parameters

    • password: string
    • salt: string
    • iterations: number
    • keylen: number

    Returns Buffer

pseudoRandomBytes

  • pseudoRandomBytes(size: number): Buffer
  • pseudoRandomBytes(size: number, callback: function): void

  • Parameters

    • size: number

    Returns Buffer

  • Parameters

    • size: number
    • callback: function
        • (err: Error, buf: Buffer): void

        • Parameters

          Returns void

    Returns void

randomBytes

  • randomBytes(size: number): Buffer
  • randomBytes(size: number, callback: function): void

  • Parameters

    • size: number

    Returns Buffer

  • Parameters

    • size: number
    • callback: function
        • (err: Error, buf: Buffer): void

        • Parameters

          Returns void

    Returns void

"dgram"

"dgram":

AddressInfo

AddressInfo:

address

address: string

family

family: string

port

port: number

RemoteInfo

RemoteInfo:

address

address: string

port

port: number

size

size: number

Socket

Socket:

addListener

  • addListener(event: string, listener: Function): EventEmitter

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

addMembership

  • addMembership(multicastAddress: string, multicastInterface?: string): void

  • Parameters

    • multicastAddress: string
    • Optional multicastInterface: string

    Returns void

address

  • Returns AddressInfo

bind

  • bind(port: number, address?: string, callback?: function): void

  • Parameters

    • port: number
    • Optional address: string
    • Optional callback: function
        • (): void

        • Returns void

    Returns void

close

  • close(): void

  • Returns void

dropMembership

  • dropMembership(multicastAddress: string, multicastInterface?: string): void

  • Parameters

    • multicastAddress: string
    • Optional multicastInterface: string

    Returns void

emit

  • emit(event: string, ...args: any[]): boolean

  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

listeners

  • listeners(event: string): Function[]

  • Parameters

    • event: string

    Returns Function[]

on

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

once

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

removeAllListeners

  • Parameters

    • Optional event: string

    Returns EventEmitter

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

send

  • send(buf: Buffer, offset: number, length: number, port: number, address: string, callback?: function): void

  • Parameters

    • buf: Buffer
    • offset: number
    • length: number
    • port: number
    • address: string
    • Optional callback: function
        • (error: Error, bytes: number): void

        • Parameters

          • error: Error
          • bytes: number

          Returns void

    Returns void

setBroadcast

  • setBroadcast(flag: boolean): void

  • Parameters

    • flag: boolean

    Returns void

setMaxListeners

  • setMaxListeners(n: number): void

  • Parameters

    • n: number

    Returns void

setMulticastLoopback

  • setMulticastLoopback(flag: boolean): void

  • Parameters

    • flag: boolean

    Returns void

setMulticastTTL

  • setMulticastTTL(ttl: number): void

  • Parameters

    • ttl: number

    Returns void

Static listenerCount

  • listenerCount(emitter: EventEmitter, event: string): number

  • Parameters

    Returns number

createSocket

  • createSocket(type: string, callback?: function): Socket

  • Parameters

    Returns Socket

"dns"

"dns":

lookup

  • lookup(domain: string, family: number, callback: function): string
  • lookup(domain: string, callback: function): string

  • Parameters

    • domain: string
    • family: number
    • callback: function
        • (err: Error, address: string, family: number): void

        • Parameters

          • err: Error
          • address: string
          • family: number

          Returns void

    Returns string

  • Parameters

    • domain: string
    • callback: function
        • (err: Error, address: string, family: number): void

        • Parameters

          • err: Error
          • address: string
          • family: number

          Returns void

    Returns string

resolve

  • resolve(domain: string, rrtype: string, callback: function): string[]
  • resolve(domain: string, callback: function): string[]

  • Parameters

    • domain: string
    • rrtype: string
    • callback: function
        • (err: Error, addresses: string[]): void

        • Parameters

          • err: Error
          • addresses: string[]

          Returns void

    Returns string[]

  • Parameters

    • domain: string
    • callback: function
        • (err: Error, addresses: string[]): void

        • Parameters

          • err: Error
          • addresses: string[]

          Returns void

    Returns string[]

resolve4

  • resolve4(domain: string, callback: function): string[]

  • Parameters

    • domain: string
    • callback: function
        • (err: Error, addresses: string[]): void

        • Parameters

          • err: Error
          • addresses: string[]

          Returns void

    Returns string[]

resolve6

  • resolve6(domain: string, callback: function): string[]

  • Parameters

    • domain: string
    • callback: function
        • (err: Error, addresses: string[]): void

        • Parameters

          • err: Error
          • addresses: string[]

          Returns void

    Returns string[]

resolveCname

  • resolveCname(domain: string, callback: function): string[]

  • Parameters

    • domain: string
    • callback: function
        • (err: Error, addresses: string[]): void

        • Parameters

          • err: Error
          • addresses: string[]

          Returns void

    Returns string[]

resolveMx

  • resolveMx(domain: string, callback: function): string[]

  • Parameters

    • domain: string
    • callback: function
        • (err: Error, addresses: string[]): void

        • Parameters

          • err: Error
          • addresses: string[]

          Returns void

    Returns string[]

resolveNs

  • resolveNs(domain: string, callback: function): string[]

  • Parameters

    • domain: string
    • callback: function
        • (err: Error, addresses: string[]): void

        • Parameters

          • err: Error
          • addresses: string[]

          Returns void

    Returns string[]

resolveSrv

  • resolveSrv(domain: string, callback: function): string[]

  • Parameters

    • domain: string
    • callback: function
        • (err: Error, addresses: string[]): void

        • Parameters

          • err: Error
          • addresses: string[]

          Returns void

    Returns string[]

resolveTxt

  • resolveTxt(domain: string, callback: function): string[]

  • Parameters

    • domain: string
    • callback: function
        • (err: Error, addresses: string[]): void

        • Parameters

          • err: Error
          • addresses: string[]

          Returns void

    Returns string[]

reverse

  • reverse(ip: string, callback: function): string[]

  • Parameters

    • ip: string
    • callback: function
        • (err: Error, domains: string[]): void

        • Parameters

          • err: Error
          • domains: string[]

          Returns void

    Returns string[]

"domain"

"domain":

Domain

Domain:

add

  • Parameters

    Returns void

addListener

  • addListener(event: string, listener: Function): Domain

  • Parameters

    • event: string
    • listener: Function

    Returns Domain

bind

  • bind(cb: function): any

  • Parameters

    • cb: function
        • (err: Error, data: any): any

        • Parameters

          • err: Error
          • data: any

          Returns any

    Returns any

dispose

  • dispose(): void

  • Returns void

emit

  • emit(event: string, ...args: any[]): boolean

  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

intercept

  • intercept(cb: function): any

  • Parameters

    • cb: function
        • (data: any): any

        • Parameters

          • data: any

          Returns any

    Returns any

listeners

  • listeners(event: string): Function[]

  • Parameters

    • event: string

    Returns Function[]

on

  • on(event: string, listener: Function): Domain

  • Parameters

    • event: string
    • listener: Function

    Returns Domain

once

  • once(event: string, listener: Function): Domain

  • Parameters

    • event: string
    • listener: Function

    Returns Domain

remove

  • Parameters

    Returns void

removeAllListeners

  • removeAllListeners(event?: string): Domain

  • Parameters

    • Optional event: string

    Returns Domain

removeListener

  • removeListener(event: string, listener: Function): Domain

  • Parameters

    • event: string
    • listener: Function

    Returns Domain

run

  • run(fn: Function): void

  • Parameters

    • fn: Function

    Returns void

setMaxListeners

  • setMaxListeners(n: number): void

  • Parameters

    • n: number

    Returns void

Static listenerCount

  • listenerCount(emitter: EventEmitter, event: string): number

  • Parameters

    Returns number

create

  • Returns Domain

"events"

"events":

EventEmitter

EventEmitter:

addListener

  • addListener(event: string, listener: Function): EventEmitter

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

emit

  • emit(event: string, ...args: any[]): boolean

  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

listeners

  • listeners(event: string): Function[]

  • Parameters

    • event: string

    Returns Function[]

on

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

once

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

removeAllListeners

  • Parameters

    • Optional event: string

    Returns EventEmitter

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

setMaxListeners

  • setMaxListeners(n: number): void

  • Parameters

    • n: number

    Returns void

Static listenerCount

  • listenerCount(emitter: EventEmitter, event: string): number

  • Parameters

    Returns number

"fs"

"fs":

FSWatcher

FSWatcher:

addListener

  • addListener(event: string, listener: Function): EventEmitter

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

close

  • close(): void

  • Returns void

emit

  • emit(event: string, ...args: any[]): boolean

  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

listeners

  • listeners(event: string): Function[]

  • Parameters

    • event: string

    Returns Function[]

on

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

once

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

removeAllListeners

  • Parameters

    • Optional event: string

    Returns EventEmitter

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

setMaxListeners

  • setMaxListeners(n: number): void

  • Parameters

    • n: number

    Returns void

Static listenerCount

  • listenerCount(emitter: EventEmitter, event: string): number

  • Parameters

    Returns number

ReadStream

ReadStream:

constructor

  • Parameters

    Returns ReadStream

readable

readable: boolean

_read

  • _read(size: number): void

  • Parameters

    • size: number

    Returns void

addListener

  • addListener(event: string, listener: Function): EventEmitter

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

close

  • close(): void

  • Returns void

emit

  • emit(event: string, ...args: any[]): boolean

  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

listeners

  • listeners(event: string): Function[]

  • Parameters

    • event: string

    Returns Function[]

on

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

once

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

pause

  • pause(): void

  • Returns void

pipe

  • pipe<T>(destination: T, options?: object): T

  • Type parameters

    Parameters

    • destination: T
    • Optional options: object
      • Optional end?: boolean

    Returns T

push

  • push(chunk: any, encoding?: string): boolean

  • Parameters

    • chunk: any
    • Optional encoding: string

    Returns boolean

read

  • read(size?: number): any

  • Parameters

    • Optional size: number

    Returns any

removeAllListeners

  • Parameters

    • Optional event: string

    Returns EventEmitter

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

resume

  • resume(): void

  • Returns void

setEncoding

  • setEncoding(encoding: string): void

  • Parameters

    • encoding: string

    Returns void

setMaxListeners

  • setMaxListeners(n: number): void

  • Parameters

    • n: number

    Returns void

unpipe

  • unpipe<T>(destination?: T): void

  • Type parameters

    Parameters

    • Optional destination: T

    Returns void

unshift

  • unshift(chunk: string): void
  • unshift(chunk: Buffer): void

  • Parameters

    • chunk: string

    Returns void

  • Parameters

    Returns void

wrap

  • Parameters

    Returns ReadableStream

Static listenerCount

  • listenerCount(emitter: EventEmitter, event: string): number

  • Parameters

    Returns number

Stats

Stats:

atime

atime: Date

blksize

blksize: number

blocks

blocks: number

ctime

ctime: Date

dev

dev: number

gid

gid: number

ino

ino: number

mode

mode: number

mtime

mtime: Date

nlink

nlink: number

rdev

rdev: number

size

size: number

uid

uid: number

isBlockDevice

  • isBlockDevice(): boolean

  • Returns boolean

isCharacterDevice

  • isCharacterDevice(): boolean

  • Returns boolean

isDirectory

  • isDirectory(): boolean

  • Returns boolean

isFIFO

  • isFIFO(): boolean

  • Returns boolean

isFile

  • isFile(): boolean

  • Returns boolean

isSocket

  • isSocket(): boolean

  • Returns boolean

isSymbolicLink

  • isSymbolicLink(): boolean

  • Returns boolean

WriteStream

WriteStream:

constructor

  • Parameters

    Returns WriteStream

writable

writable: boolean

_write

  • _write(data: Buffer, encoding: string, callback: Function): void
  • _write(data: string, encoding: string, callback: Function): void

  • Parameters

    • data: Buffer
    • encoding: string
    • callback: Function

    Returns void

  • Parameters

    • data: string
    • encoding: string
    • callback: Function

    Returns void

addListener

  • addListener(event: string, listener: Function): EventEmitter

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

close

  • close(): void

  • Returns void

emit

  • emit(event: string, ...args: any[]): boolean

  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

end

  • end(): void
  • end(buffer: Buffer, cb?: Function): void
  • end(str: string, cb?: Function): void
  • end(str: string, encoding?: string, cb?: Function): void

  • Returns void

  • Parameters

    • buffer: Buffer
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns void

listeners

  • listeners(event: string): Function[]

  • Parameters

    • event: string

    Returns Function[]

on

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

once

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

removeAllListeners

  • Parameters

    • Optional event: string

    Returns EventEmitter

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

setMaxListeners

  • setMaxListeners(n: number): void

  • Parameters

    • n: number

    Returns void

write

  • write(buffer: Buffer, cb?: Function): boolean
  • write(str: string, cb?: Function): boolean
  • write(str: string, encoding?: string, cb?: Function): boolean

  • Parameters

    • buffer: Buffer
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns boolean

Static listenerCount

  • listenerCount(emitter: EventEmitter, event: string): number

  • Parameters

    Returns number

appendFile

  • appendFile(filename: string, data: any, options: object, callback?: function): void
  • appendFile(filename: string, data: any, options: object, callback?: function): void
  • appendFile(filename: string, data: any, callback?: function): void

  • Parameters

    • filename: string
    • data: any
    • options: object
      • Optional encoding?: string
      • Optional flag?: string
      • Optional mode?: number
    • Optional callback: function

    Returns void

  • Parameters

    • filename: string
    • data: any
    • options: object
      • Optional encoding?: string
      • Optional flag?: string
      • Optional mode?: string
    • Optional callback: function

    Returns void

  • Parameters

    Returns void

appendFileSync

  • appendFileSync(filename: string, data: any, options?: object): void
  • appendFileSync(filename: string, data: any, options?: object): void

  • Parameters

    • filename: string
    • data: any
    • Optional options: object
      • Optional encoding?: string
      • Optional flag?: string
      • Optional mode?: number

    Returns void

  • Parameters

    • filename: string
    • data: any
    • Optional options: object
      • Optional encoding?: string
      • Optional flag?: string
      • Optional mode?: string

    Returns void

chmod

  • chmod(path: string, mode: number, callback?: function): void
  • chmod(path: string, mode: string, callback?: function): void

  • Parameters

    Returns void

  • Parameters

    Returns void

chmodSync

  • chmodSync(path: string, mode: number): void
  • chmodSync(path: string, mode: string): void

  • Parameters

    • path: string
    • mode: number

    Returns void

  • Parameters

    • path: string
    • mode: string

    Returns void

chown

  • chown(path: string, uid: number, gid: number, callback?: function): void

  • Parameters

    • path: string
    • uid: number
    • gid: number
    • Optional callback: function

    Returns void

chownSync

  • chownSync(path: string, uid: number, gid: number): void

  • Parameters

    • path: string
    • uid: number
    • gid: number

    Returns void

close

  • close(fd: number, callback?: function): void

  • Parameters

    Returns void

closeSync

  • closeSync(fd: number): void

  • Parameters

    • fd: number

    Returns void

createReadStream

  • createReadStream(path: string, options?: object): ReadStream
  • createReadStream(path: string, options?: object): ReadStream

  • Parameters

    • path: string
    • Optional options: object
      • Optional bufferSize?: number
      • Optional encoding?: string
      • Optional fd?: string
      • Optional flags?: string
      • Optional mode?: number

    Returns ReadStream

  • Parameters

    • path: string
    • Optional options: object
      • Optional bufferSize?: number
      • Optional encoding?: string
      • Optional fd?: string
      • Optional flags?: string
      • Optional mode?: string

    Returns ReadStream

createWriteStream

  • createWriteStream(path: string, options?: object): WriteStream

  • Parameters

    • path: string
    • Optional options: object
      • Optional encoding?: string
      • Optional flags?: string
      • Optional string?: string

    Returns WriteStream

exists

  • exists(path: string, callback?: function): void

  • Parameters

    • path: string
    • Optional callback: function
        • (exists: boolean): void

        • Parameters

          • exists: boolean

          Returns void

    Returns void

existsSync

  • existsSync(path: string): boolean

  • Parameters

    • path: string

    Returns boolean

fchmod

  • fchmod(fd: number, mode: number, callback?: function): void
  • fchmod(fd: number, mode: string, callback?: function): void

  • Parameters

    Returns void

  • Parameters

    Returns void

fchmodSync

  • fchmodSync(fd: number, mode: number): void
  • fchmodSync(fd: number, mode: string): void

  • Parameters

    • fd: number
    • mode: number

    Returns void

  • Parameters

    • fd: number
    • mode: string

    Returns void

fchown

  • fchown(fd: number, uid: number, gid: number, callback?: function): void

  • Parameters

    • fd: number
    • uid: number
    • gid: number
    • Optional callback: function

    Returns void

fchownSync

  • fchownSync(fd: number, uid: number, gid: number): void

  • Parameters

    • fd: number
    • uid: number
    • gid: number

    Returns void

fstat

  • fstat(fd: number, callback?: function): void

  • Parameters

    Returns void

fstatSync

  • fstatSync(fd: number): Stats

  • Parameters

    • fd: number

    Returns Stats

fsync

  • fsync(fd: number, callback?: function): void

  • Parameters

    Returns void

fsyncSync

  • fsyncSync(fd: number): void

  • Parameters

    • fd: number

    Returns void

ftruncate

  • ftruncate(fd: number, callback?: function): void
  • ftruncate(fd: number, len: number, callback?: function): void

  • Parameters

    Returns void

  • Parameters

    Returns void

ftruncateSync

  • ftruncateSync(fd: number, len?: number): void

  • Parameters

    • fd: number
    • Optional len: number

    Returns void

futimes

  • futimes(fd: number, atime: number, mtime: number, callback?: function): void
  • futimes(fd: number, atime: Date, mtime: Date, callback?: function): void

  • Parameters

    • fd: number
    • atime: number
    • mtime: number
    • Optional callback: function

    Returns void

  • Parameters

    • fd: number
    • atime: Date
    • mtime: Date
    • Optional callback: function

    Returns void

futimesSync

  • futimesSync(fd: number, atime: number, mtime: number): void
  • futimesSync(fd: number, atime: Date, mtime: Date): void

  • Parameters

    • fd: number
    • atime: number
    • mtime: number

    Returns void

  • Parameters

    • fd: number
    • atime: Date
    • mtime: Date

    Returns void

lchmod

  • lchmod(path: string, mode: number, callback?: function): void
  • lchmod(path: string, mode: string, callback?: function): void

  • Parameters

    Returns void

  • Parameters

    Returns void

lchmodSync

  • lchmodSync(path: string, mode: number): void
  • lchmodSync(path: string, mode: string): void

  • Parameters

    • path: string
    • mode: number

    Returns void

  • Parameters

    • path: string
    • mode: string

    Returns void

lchown

  • lchown(path: string, uid: number, gid: number, callback?: function): void

  • Parameters

    • path: string
    • uid: number
    • gid: number
    • Optional callback: function

    Returns void

lchownSync

  • lchownSync(path: string, uid: number, gid: number): void

  • Parameters

    • path: string
    • uid: number
    • gid: number

    Returns void

link

  • link(srcpath: string, dstpath: string, callback?: function): void

  • Parameters

    • srcpath: string
    • dstpath: string
    • Optional callback: function

    Returns void

linkSync

  • linkSync(srcpath: string, dstpath: string): void

  • Parameters

    • srcpath: string
    • dstpath: string

    Returns void

lstat

  • lstat(path: string, callback?: function): void

  • Parameters

    Returns void

lstatSync

  • lstatSync(path: string): Stats

  • Parameters

    • path: string

    Returns Stats

mkdir

  • mkdir(path: string, callback?: function): void
  • mkdir(path: string, mode: number, callback?: function): void
  • mkdir(path: string, mode: string, callback?: function): void

  • Parameters

    Returns void

  • Parameters

    Returns void

  • Parameters

    Returns void

mkdirSync

  • mkdirSync(path: string, mode?: number): void
  • mkdirSync(path: string, mode?: string): void

  • Parameters

    • path: string
    • Optional mode: number

    Returns void

  • Parameters

    • path: string
    • Optional mode: string

    Returns void

open

  • open(path: string, flags: string, callback?: function): void
  • open(path: string, flags: string, mode: number, callback?: function): void
  • open(path: string, flags: string, mode: string, callback?: function): void

  • Parameters

    • path: string
    • flags: string
    • Optional callback: function

    Returns void

  • Parameters

    • path: string
    • flags: string
    • mode: number
    • Optional callback: function

    Returns void

  • Parameters

    • path: string
    • flags: string
    • mode: string
    • Optional callback: function

    Returns void

openSync

  • openSync(path: string, flags: string, mode?: number): number
  • openSync(path: string, flags: string, mode?: string): number

  • Parameters

    • path: string
    • flags: string
    • Optional mode: number

    Returns number

  • Parameters

    • path: string
    • flags: string
    • Optional mode: string

    Returns number

read

  • read(fd: number, buffer: Buffer, offset: number, length: number, position: number, callback?: function): void

  • Parameters

    • fd: number
    • buffer: Buffer
    • offset: number
    • length: number
    • position: number
    • Optional callback: function

    Returns void

readFile

  • readFile(filename: string, encoding: string, callback: function): void
  • readFile(filename: string, options: object, callback: function): void
  • readFile(filename: string, options: object, callback: function): void
  • readFile(filename: string, callback: function): void

  • Parameters

    • filename: string
    • encoding: string
    • callback: function

    Returns void

  • Parameters

    • filename: string
    • options: object
      • encoding: string
      • Optional flag?: string
    • callback: function

    Returns void

  • Parameters

    Returns void

  • Parameters

    Returns void

readFileSync

  • readFileSync(filename: string, encoding: string): string
  • readFileSync(filename: string, options: object): string
  • readFileSync(filename: string, options?: object): Buffer

  • Parameters

    • filename: string
    • encoding: string

    Returns string

  • Parameters

    • filename: string
    • options: object
      • encoding: string
      • Optional flag?: string

    Returns string

  • Parameters

    • filename: string
    • Optional options: object
      • Optional flag?: string

    Returns Buffer

readSync

  • readSync(fd: number, buffer: Buffer, offset: number, length: number, position: number): number

  • Parameters

    • fd: number
    • buffer: Buffer
    • offset: number
    • length: number
    • position: number

    Returns number

readdir

  • readdir(path: string, callback?: function): void

  • Parameters

    • path: string
    • Optional callback: function

    Returns void

readdirSync

  • readdirSync(path: string): string[]

  • Parameters

    • path: string

    Returns string[]

readlink

  • readlink(path: string, callback?: function): void

  • Parameters

    • path: string
    • Optional callback: function

    Returns void

readlinkSync

  • readlinkSync(path: string): string

  • Parameters

    • path: string

    Returns string

realpath

  • realpath(path: string, callback?: function): void
  • realpath(path: string, cache: object, callback: function): void

  • Parameters

    • path: string
    • Optional callback: function

    Returns void

  • Parameters

    • path: string
    • cache: object
      • [path: string]: string
    • callback: function

    Returns void

realpathSync

  • realpathSync(path: string, cache?: object): string

  • Parameters

    • path: string
    • Optional cache: object
      • [path: string]: string

    Returns string

rename

  • rename(oldPath: string, newPath: string, callback?: function): void

  • Parameters

    • oldPath: string
    • newPath: string
    • Optional callback: function

    Returns void

renameSync

  • renameSync(oldPath: string, newPath: string): void

  • Parameters

    • oldPath: string
    • newPath: string

    Returns void

rmdir

  • rmdir(path: string, callback?: function): void

  • Parameters

    Returns void

rmdirSync

  • rmdirSync(path: string): void

  • Parameters

    • path: string

    Returns void

stat

  • stat(path: string, callback?: function): void

  • Parameters

    Returns void

statSync

  • statSync(path: string): Stats

  • Parameters

    • path: string

    Returns Stats

symlink

  • symlink(srcpath: string, dstpath: string, type?: string, callback?: function): void

  • Parameters

    • srcpath: string
    • dstpath: string
    • Optional type: string
    • Optional callback: function

    Returns void

symlinkSync

  • symlinkSync(srcpath: string, dstpath: string, type?: string): void

  • Parameters

    • srcpath: string
    • dstpath: string
    • Optional type: string

    Returns void

truncate

  • truncate(path: string, callback?: function): void
  • truncate(path: string, len: number, callback?: function): void

  • Parameters

    Returns void

  • Parameters

    Returns void

truncateSync

  • truncateSync(path: string, len?: number): void

  • Parameters

    • path: string
    • Optional len: number

    Returns void

unlink

  • unlink(path: string, callback?: function): void

  • Parameters

    Returns void

unlinkSync

  • unlinkSync(path: string): void

  • Parameters

    • path: string

    Returns void

unwatchFile

  • unwatchFile(filename: string, listener?: function): void

  • Parameters

    • filename: string
    • Optional listener: function

    Returns void

utimes

  • utimes(path: string, atime: number, mtime: number, callback?: function): void
  • utimes(path: string, atime: Date, mtime: Date, callback?: function): void

  • Parameters

    • path: string
    • atime: number
    • mtime: number
    • Optional callback: function

    Returns void

  • Parameters

    • path: string
    • atime: Date
    • mtime: Date
    • Optional callback: function

    Returns void

utimesSync

  • utimesSync(path: string, atime: number, mtime: number): void
  • utimesSync(path: string, atime: Date, mtime: Date): void

  • Parameters

    • path: string
    • atime: number
    • mtime: number

    Returns void

  • Parameters

    • path: string
    • atime: Date
    • mtime: Date

    Returns void

watch

  • watch(filename: string, listener?: function): FSWatcher
  • watch(filename: string, options: object, listener?: function): FSWatcher

  • Parameters

    • filename: string
    • Optional listener: function
        • (event: string, filename: string): any

        • Parameters

          • event: string
          • filename: string

          Returns any

    Returns FSWatcher

  • Parameters

    • filename: string
    • options: object
      • Optional persistent?: boolean
    • Optional listener: function
        • (event: string, filename: string): any

        • Parameters

          • event: string
          • filename: string

          Returns any

    Returns FSWatcher

watchFile

  • watchFile(filename: string, listener: function): void
  • watchFile(filename: string, options: object, listener: function): void

  • Parameters

    • filename: string
    • listener: function

    Returns void

  • Parameters

    • filename: string
    • options: object
      • Optional interval?: number
      • Optional persistent?: boolean
    • listener: function

    Returns void

write

  • write(fd: number, buffer: Buffer, offset: number, length: number, position: number, callback?: function): void

  • Parameters

    • fd: number
    • buffer: Buffer
    • offset: number
    • length: number
    • position: number
    • Optional callback: function

    Returns void

writeFile

  • writeFile(filename: string, data: any, callback?: function): void
  • writeFile(filename: string, data: any, options: object, callback?: function): void
  • writeFile(filename: string, data: any, options: object, callback?: function): void

  • Parameters

    Returns void

  • Parameters

    • filename: string
    • data: any
    • options: object
      • Optional encoding?: string
      • Optional flag?: string
      • Optional mode?: number
    • Optional callback: function

    Returns void

  • Parameters

    • filename: string
    • data: any
    • options: object
      • Optional encoding?: string
      • Optional flag?: string
      • Optional mode?: string
    • Optional callback: function

    Returns void

writeFileSync

  • writeFileSync(filename: string, data: any, options?: object): void
  • writeFileSync(filename: string, data: any, options?: object): void

  • Parameters

    • filename: string
    • data: any
    • Optional options: object
      • Optional encoding?: string
      • Optional flag?: string
      • Optional mode?: number

    Returns void

  • Parameters

    • filename: string
    • data: any
    • Optional options: object
      • Optional encoding?: string
      • Optional flag?: string
      • Optional mode?: string

    Returns void

writeSync

  • writeSync(fd: number, buffer: Buffer, offset: number, length: number, position: number): number

  • Parameters

    • fd: number
    • buffer: Buffer
    • offset: number
    • length: number
    • position: number

    Returns number

"http"

"http":

Agent

Agent:

constructor

  • Parameters

    Returns Agent

maxSockets

maxSockets: number

requests

requests: any

sockets

sockets: any

destroy

  • destroy(): void

  • Destroy any sockets that are currently in use by the agent. It is usually not necessary to do this. However, if you are using an agent with KeepAlive enabled, then it is best to explicitly shut down the agent when you know that it will no longer be used. Otherwise, sockets may hang open for quite a long time before the server terminates them.

    Returns void

AgentOptions

AgentOptions:

Optional keepAlive

keepAlive: boolean

Keep sockets around in a pool to be used by other requests in the future. Default = false

Optional keepAliveMsecs

keepAliveMsecs: number

When using HTTP KeepAlive, how often to send TCP KeepAlive packets over sockets being kept alive. Default = 1000. Only relevant if keepAlive is set to true.

Optional maxFreeSockets

maxFreeSockets: number

Maximum number of sockets to leave open in a free state. Only relevant if keepAlive is set to true. Default = 256.

Optional maxSockets

maxSockets: number

Maximum number of sockets to allow per host. Default for Node 0.10 is 5, default for Node 0.12 is Infinity

ClientRequest

ClientRequest:

constructor

  • Parameters

    Returns ClientRequest

writable

writable: boolean

_write

  • _write(data: Buffer, encoding: string, callback: Function): void
  • _write(data: string, encoding: string, callback: Function): void

  • Parameters

    • data: Buffer
    • encoding: string
    • callback: Function

    Returns void

  • Parameters

    • data: string
    • encoding: string
    • callback: Function

    Returns void

abort

  • abort(): void

  • Returns void

addListener

  • addListener(event: string, listener: Function): EventEmitter

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

emit

  • emit(event: string, ...args: any[]): boolean

  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

end

  • end(): void
  • end(buffer: Buffer, cb?: Function): void
  • end(str: string, cb?: Function): void
  • end(str: string, encoding?: string, cb?: Function): void
  • end(data?: any, encoding?: string): void

  • Returns void

  • Parameters

    • buffer: Buffer
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns void

  • Parameters

    • Optional data: any
    • Optional encoding: string

    Returns void

listeners

  • listeners(event: string): Function[]

  • Parameters

    • event: string

    Returns Function[]

on

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

once

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

removeAllListeners

  • Parameters

    • Optional event: string

    Returns EventEmitter

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

setMaxListeners

  • setMaxListeners(n: number): void

  • Parameters

    • n: number

    Returns void

setNoDelay

  • setNoDelay(noDelay?: boolean): void

  • Parameters

    • Optional noDelay: boolean

    Returns void

setSocketKeepAlive

  • setSocketKeepAlive(enable?: boolean, initialDelay?: number): void

  • Parameters

    • Optional enable: boolean
    • Optional initialDelay: number

    Returns void

setTimeout

  • setTimeout(timeout: number, callback?: Function): void

  • Parameters

    • timeout: number
    • Optional callback: Function

    Returns void

write

  • write(buffer: Buffer): boolean
  • write(buffer: Buffer, cb?: Function): boolean
  • write(str: string, cb?: Function): boolean
  • write(str: string, encoding?: string, cb?: Function): boolean
  • write(str: string, encoding?: string, fd?: string): boolean
  • write(chunk: any, encoding?: string): void

  • Parameters

    Returns boolean

  • Parameters

    • buffer: Buffer
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional fd: string

    Returns boolean

  • Parameters

    • chunk: any
    • Optional encoding: string

    Returns void

Static listenerCount

  • listenerCount(emitter: EventEmitter, event: string): number

  • Parameters

    Returns number

ClientResponse

ClientResponse:

constructor

  • Parameters

    Returns ClientResponse

headers

headers: any

httpVersion

httpVersion: string

readable

readable: boolean

statusCode

statusCode: number

trailers

trailers: any

_read

  • _read(size: number): void

  • Parameters

    • size: number

    Returns void

addListener

  • addListener(event: string, listener: Function): EventEmitter

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

emit

  • emit(event: string, ...args: any[]): boolean

  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

listeners

  • listeners(event: string): Function[]

  • Parameters

    • event: string

    Returns Function[]

on

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

once

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

pause

  • pause(): void

  • Returns void

pipe

  • pipe<T>(destination: T, options?: object): T

  • Type parameters

    Parameters

    • destination: T
    • Optional options: object
      • Optional end?: boolean

    Returns T

push

  • push(chunk: any, encoding?: string): boolean

  • Parameters

    • chunk: any
    • Optional encoding: string

    Returns boolean

read

  • read(size?: number): any

  • Parameters

    • Optional size: number

    Returns any

removeAllListeners

  • Parameters

    • Optional event: string

    Returns EventEmitter

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

resume

  • resume(): void

  • Returns void

setEncoding

  • setEncoding(encoding?: string): void

  • Parameters

    • Optional encoding: string

    Returns void

setMaxListeners

  • setMaxListeners(n: number): void

  • Parameters

    • n: number

    Returns void

unpipe

  • unpipe<T>(destination?: T): void

  • Type parameters

    Parameters

    • Optional destination: T

    Returns void

unshift

  • unshift(chunk: string): void
  • unshift(chunk: Buffer): void

  • Parameters

    • chunk: string

    Returns void

  • Parameters

    Returns void

wrap

  • Parameters

    Returns ReadableStream

Static listenerCount

  • listenerCount(emitter: EventEmitter, event: string): number

  • Parameters

    Returns number

Server

Server:

maxHeadersCount

maxHeadersCount: number

addListener

  • addListener(event: string, listener: Function): EventEmitter

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

address

  • address(): object

  • Returns object

    • address: string
    • family: string
    • port: number

close

  • Parameters

    • Optional cb: any

    Returns Server

emit

  • emit(event: string, ...args: any[]): boolean

  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

listen

  • listen(port: number, hostname?: string, backlog?: number, callback?: Function): Server
  • listen(path: string, callback?: Function): Server
  • listen(handle: any, listeningListener?: Function): Server

  • Parameters

    • port: number
    • Optional hostname: string
    • Optional backlog: number
    • Optional callback: Function

    Returns Server

  • Parameters

    • path: string
    • Optional callback: Function

    Returns Server

  • Parameters

    • handle: any
    • Optional listeningListener: Function

    Returns Server

listeners

  • listeners(event: string): Function[]

  • Parameters

    • event: string

    Returns Function[]

on

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

once

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

removeAllListeners

  • Parameters

    • Optional event: string

    Returns EventEmitter

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

setMaxListeners

  • setMaxListeners(n: number): void

  • Parameters

    • n: number

    Returns void

Static listenerCount

  • listenerCount(emitter: EventEmitter, event: string): number

  • Parameters

    Returns number

ServerRequest

ServerRequest:

constructor

  • Parameters

    Returns ServerRequest

connection

connection: Socket

headers

headers: any

httpVersion

httpVersion: string

method

method: string

readable

readable: boolean

trailers

trailers: string

url

url: string

_read

  • _read(size: number): void

  • Parameters

    • size: number

    Returns void

addListener

  • addListener(event: string, listener: Function): EventEmitter

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

emit

  • emit(event: string, ...args: any[]): boolean

  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

listeners

  • listeners(event: string): Function[]

  • Parameters

    • event: string

    Returns Function[]

on

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

once

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

pause

  • pause(): void

  • Returns void

pipe

  • pipe<T>(destination: T, options?: object): T

  • Type parameters

    Parameters

    • destination: T
    • Optional options: object
      • Optional end?: boolean

    Returns T

push

  • push(chunk: any, encoding?: string): boolean

  • Parameters

    • chunk: any
    • Optional encoding: string

    Returns boolean

read

  • read(size?: number): any

  • Parameters

    • Optional size: number

    Returns any

removeAllListeners

  • Parameters

    • Optional event: string

    Returns EventEmitter

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

resume

  • resume(): void

  • Returns void

setEncoding

  • setEncoding(encoding?: string): void

  • Parameters

    • Optional encoding: string

    Returns void

setMaxListeners

  • setMaxListeners(n: number): void

  • Parameters

    • n: number

    Returns void

unpipe

  • unpipe<T>(destination?: T): void

  • Type parameters

    Parameters

    • Optional destination: T

    Returns void

unshift

  • unshift(chunk: string): void
  • unshift(chunk: Buffer): void

  • Parameters

    • chunk: string

    Returns void

  • Parameters

    Returns void

wrap

  • Parameters

    Returns ReadableStream

Static listenerCount

  • listenerCount(emitter: EventEmitter, event: string): number

  • Parameters

    Returns number

ServerResponse

ServerResponse:

constructor

  • Parameters

    Returns ServerResponse

sendDate

sendDate: boolean

statusCode

statusCode: number

writable

writable: boolean

_write

  • _write(data: Buffer, encoding: string, callback: Function): void
  • _write(data: string, encoding: string, callback: Function): void

  • Parameters

    • data: Buffer
    • encoding: string
    • callback: Function

    Returns void

  • Parameters

    • data: string
    • encoding: string
    • callback: Function

    Returns void

addListener

  • addListener(event: string, listener: Function): EventEmitter

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

addTrailers

  • addTrailers(headers: any): void

  • Parameters

    • headers: any

    Returns void

emit

  • emit(event: string, ...args: any[]): boolean

  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

end

  • end(): void
  • end(buffer: Buffer, cb?: Function): void
  • end(str: string, cb?: Function): void
  • end(str: string, encoding?: string, cb?: Function): void
  • end(data?: any, encoding?: string): void

  • Returns void

  • Parameters

    • buffer: Buffer
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns void

  • Parameters

    • Optional data: any
    • Optional encoding: string

    Returns void

getHeader

  • getHeader(name: string): string

  • Parameters

    • name: string

    Returns string

listeners

  • listeners(event: string): Function[]

  • Parameters

    • event: string

    Returns Function[]

on

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

once

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

removeAllListeners

  • Parameters

    • Optional event: string

    Returns EventEmitter

removeHeader

  • removeHeader(name: string): void

  • Parameters

    • name: string

    Returns void

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

setHeader

  • setHeader(name: string, value: string): void

  • Parameters

    • name: string
    • value: string

    Returns void

setMaxListeners

  • setMaxListeners(n: number): void

  • Parameters

    • n: number

    Returns void

write

  • write(buffer: Buffer): boolean
  • write(buffer: Buffer, cb?: Function): boolean
  • write(str: string, cb?: Function): boolean
  • write(str: string, encoding?: string, cb?: Function): boolean
  • write(str: string, encoding?: string, fd?: string): boolean
  • write(chunk: any, encoding?: string): any

  • Parameters

    Returns boolean

  • Parameters

    • buffer: Buffer
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional fd: string

    Returns boolean

  • Parameters

    • chunk: any
    • Optional encoding: string

    Returns any

writeContinue

  • writeContinue(): void

  • Returns void

writeHead

  • writeHead(statusCode: number, reasonPhrase?: string, headers?: any): void
  • writeHead(statusCode: number, headers?: any): void

  • Parameters

    • statusCode: number
    • Optional reasonPhrase: string
    • Optional headers: any

    Returns void

  • Parameters

    • statusCode: number
    • Optional headers: any

    Returns void

Static listenerCount

  • listenerCount(emitter: EventEmitter, event: string): number

  • Parameters

    Returns number

STATUS_CODES

STATUS_CODES: object

Type declaration

  • [errorCode: string]: string

globalAgent

globalAgent: Agent

createClient

  • createClient(port?: number, host?: string): any

  • Parameters

    • Optional port: number
    • Optional host: string

    Returns any

createServer

  • createServer(requestListener?: function): Server

get

  • Parameters

    • options: any
    • Optional callback: Function

    Returns ClientRequest

request

  • Parameters

    • options: any
    • Optional callback: Function

    Returns ClientRequest

"https"

"https":

Agent

Agent:

maxSockets

maxSockets: number

requests

requests: any

sockets

sockets: any

RequestOptions

RequestOptions:

Optional agent

agent: any

Optional auth

auth: string

Optional ca

ca: any

Optional cert

cert: any

Optional ciphers

ciphers: string

Optional headers

headers: any

Optional host

host: string

Optional hostname

hostname: string

Optional key

key: any

Optional method

method: string

Optional passphrase

passphrase: string

Optional path

path: string

Optional pfx

pfx: any

Optional port

port: number

Optional rejectUnauthorized

rejectUnauthorized: boolean

Server

Server:

constructor

  • Parameters

    Returns Server

bufferSize

bufferSize: number

bytesRead

bytesRead: number

bytesWritten

bytesWritten: number

connections

connections: number

maxConnections

maxConnections: number

readable

readable: boolean

remoteAddress

remoteAddress: string

remotePort

remotePort: number

writable

writable: boolean

_read

  • _read(size: number): void

  • Parameters

    • size: number

    Returns void

_write

  • _write(data: Buffer, encoding: string, callback: Function): void
  • _write(data: string, encoding: string, callback: Function): void

  • Parameters

    • data: Buffer
    • encoding: string
    • callback: Function

    Returns void

  • Parameters

    • data: string
    • encoding: string
    • callback: Function

    Returns void

addContext

  • addContext(hostName: string, credentials: object): void

  • Parameters

    • hostName: string
    • credentials: object
      • ca: string
      • cert: string
      • key: string

    Returns void

addListener

  • addListener(event: string, listener: Function): EventEmitter

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

address

  • address(): object

  • Returns object

    • address: string
    • family: string
    • port: number

close

  • Returns Server

connect

  • connect(port: number, host?: string, connectionListener?: Function): void
  • connect(path: string, connectionListener?: Function): void

  • Parameters

    • port: number
    • Optional host: string
    • Optional connectionListener: Function

    Returns void

  • Parameters

    • path: string
    • Optional connectionListener: Function

    Returns void

destroy

  • destroy(): void

  • Returns void

emit

  • emit(event: string, ...args: any[]): boolean

  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

end

  • end(): void
  • end(buffer: Buffer, cb?: Function): void
  • end(str: string, cb?: Function): void
  • end(str: string, encoding?: string, cb?: Function): void
  • end(data?: any, encoding?: string): void

  • Returns void

  • Parameters

    • buffer: Buffer
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns void

  • Parameters

    • Optional data: any
    • Optional encoding: string

    Returns void

listen

  • listen(port: number, host?: string, backlog?: number, listeningListener?: Function): Server
  • listen(path: string, listeningListener?: Function): Server
  • listen(handle: any, listeningListener?: Function): Server
  • listen(port: number, host?: string, callback?: Function): Server

  • Parameters

    • port: number
    • Optional host: string
    • Optional backlog: number
    • Optional listeningListener: Function

    Returns Server

  • Parameters

    • path: string
    • Optional listeningListener: Function

    Returns Server

  • Parameters

    • handle: any
    • Optional listeningListener: Function

    Returns Server

  • Parameters

    • port: number
    • Optional host: string
    • Optional callback: Function

    Returns Server

listeners

  • listeners(event: string): Function[]

  • Parameters

    • event: string

    Returns Function[]

on

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

once

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

pause

  • pause(): void

  • Returns void

pipe

  • pipe<T>(destination: T, options?: object): T

  • Type parameters

    Parameters

    • destination: T
    • Optional options: object
      • Optional end?: boolean

    Returns T

push

  • push(chunk: any, encoding?: string): boolean

  • Parameters

    • chunk: any
    • Optional encoding: string

    Returns boolean

read

  • read(size?: number): any

  • Parameters

    • Optional size: number

    Returns any

ref

  • ref(): void

  • Returns void

removeAllListeners

  • Parameters

    • Optional event: string

    Returns EventEmitter

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

resume

  • resume(): void

  • Returns void

setEncoding

  • setEncoding(encoding?: string): void

  • Parameters

    • Optional encoding: string

    Returns void

setKeepAlive

  • setKeepAlive(enable?: boolean, initialDelay?: number): void

  • Parameters

    • Optional enable: boolean
    • Optional initialDelay: number

    Returns void

setMaxListeners

  • setMaxListeners(n: number): void

  • Parameters

    • n: number

    Returns void

setNoDelay

  • setNoDelay(noDelay?: boolean): void

  • Parameters

    • Optional noDelay: boolean

    Returns void

setTimeout

  • setTimeout(timeout: number, callback?: Function): void

  • Parameters

    • timeout: number
    • Optional callback: Function

    Returns void

unpipe

  • unpipe<T>(destination?: T): void

  • Type parameters

    Parameters

    • Optional destination: T

    Returns void

unref

  • unref(): void

  • Returns void

unshift

  • unshift(chunk: string): void
  • unshift(chunk: Buffer): void

  • Parameters

    • chunk: string

    Returns void

  • Parameters

    Returns void

wrap

  • Parameters

    Returns ReadableStream

write

  • write(buffer: Buffer): boolean
  • write(buffer: Buffer, cb?: Function): boolean
  • write(str: string, cb?: Function): boolean
  • write(str: string, encoding?: string, cb?: Function): boolean
  • write(str: string, encoding?: string, fd?: string): boolean
  • write(data: any, encoding?: string, callback?: Function): void

  • Parameters

    Returns boolean

  • Parameters

    • buffer: Buffer
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional fd: string

    Returns boolean

  • Parameters

    • data: any
    • Optional encoding: string
    • Optional callback: Function

    Returns void

Static listenerCount

  • listenerCount(emitter: EventEmitter, event: string): number

  • Parameters

    Returns number

ServerOptions

ServerOptions:

Optional NPNProtocols

NPNProtocols: any

Optional SNICallback

SNICallback: function

Type declaration

    • (servername: string): any

    • Parameters

      • servername: string

      Returns any

Optional ca

ca: any

Optional cert

cert: any

Optional ciphers

ciphers: string

Optional crl

crl: any

Optional honorCipherOrder

honorCipherOrder: boolean

Optional key

key: any

Optional passphrase

passphrase: string

Optional pfx

pfx: any

Optional rejectUnauthorized

rejectUnauthorized: boolean

Optional requestCert

requestCert: boolean

globalAgent

globalAgent: Agent

createServer

  • Parameters

    Returns Server

get

request

"net"

"net":

Server

Server:

constructor

  • Parameters

    Returns Server

Socket

Socket: object

Type declaration

  • constructor: function
    • new __type(options?: object): __type

    • Parameters

      • Optional options: object
        • Optional allowHalfOpen?: boolean
        • Optional fd?: string
        • Optional type?: string

      Returns __type

bufferSize

bufferSize: number

bytesRead

bytesRead: number

bytesWritten

bytesWritten: number

connections

connections: number

maxConnections

maxConnections: number

readable

readable: boolean

remoteAddress

remoteAddress: string

remotePort

remotePort: number

writable

writable: boolean

_read

  • _read(size: number): void

  • Parameters

    • size: number

    Returns void

_write

  • _write(data: Buffer, encoding: string, callback: Function): void
  • _write(data: string, encoding: string, callback: Function): void

  • Parameters

    • data: Buffer
    • encoding: string
    • callback: Function

    Returns void

  • Parameters

    • data: string
    • encoding: string
    • callback: Function

    Returns void

addListener

  • addListener(event: string, listener: Function): EventEmitter

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

address

  • address(): object

  • Returns object

    • address: string
    • family: string
    • port: number

close

  • close(callback?: Function): Server

  • Parameters

    • Optional callback: Function

    Returns Server

connect

  • connect(port: number, host?: string, connectionListener?: Function): void
  • connect(path: string, connectionListener?: Function): void

  • Parameters

    • port: number
    • Optional host: string
    • Optional connectionListener: Function

    Returns void

  • Parameters

    • path: string
    • Optional connectionListener: Function

    Returns void

destroy

  • destroy(): void

  • Returns void

emit

  • emit(event: string, ...args: any[]): boolean

  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

end

  • end(): void
  • end(buffer: Buffer, cb?: Function): void
  • end(str: string, cb?: Function): void
  • end(str: string, encoding?: string, cb?: Function): void
  • end(data?: any, encoding?: string): void

  • Returns void

  • Parameters

    • buffer: Buffer
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns void

  • Parameters

    • Optional data: any
    • Optional encoding: string

    Returns void

listen

  • listen(port: number, host?: string, backlog?: number, listeningListener?: Function): Server
  • listen(path: string, listeningListener?: Function): Server
  • listen(handle: any, listeningListener?: Function): Server

  • Parameters

    • port: number
    • Optional host: string
    • Optional backlog: number
    • Optional listeningListener: Function

    Returns Server

  • Parameters

    • path: string
    • Optional listeningListener: Function

    Returns Server

  • Parameters

    • handle: any
    • Optional listeningListener: Function

    Returns Server

listeners

  • listeners(event: string): Function[]

  • Parameters

    • event: string

    Returns Function[]

on

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

once

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

pause

  • pause(): void

  • Returns void

pipe

  • pipe<T>(destination: T, options?: object): T

  • Type parameters

    Parameters

    • destination: T
    • Optional options: object
      • Optional end?: boolean

    Returns T

push

  • push(chunk: any, encoding?: string): boolean

  • Parameters

    • chunk: any
    • Optional encoding: string

    Returns boolean

read

  • read(size?: number): any

  • Parameters

    • Optional size: number

    Returns any

ref

  • ref(): void

  • Returns void

removeAllListeners

  • Parameters

    • Optional event: string

    Returns EventEmitter

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

resume

  • resume(): void

  • Returns void

setEncoding

  • setEncoding(encoding?: string): void

  • Parameters

    • Optional encoding: string

    Returns void

setKeepAlive

  • setKeepAlive(enable?: boolean, initialDelay?: number): void

  • Parameters

    • Optional enable: boolean
    • Optional initialDelay: number

    Returns void

setMaxListeners

  • setMaxListeners(n: number): void

  • Parameters

    • n: number

    Returns void

setNoDelay

  • setNoDelay(noDelay?: boolean): void

  • Parameters

    • Optional noDelay: boolean

    Returns void

setTimeout

  • setTimeout(timeout: number, callback?: Function): void

  • Parameters

    • timeout: number
    • Optional callback: Function

    Returns void

unpipe

  • unpipe<T>(destination?: T): void

  • Type parameters

    Parameters

    • Optional destination: T

    Returns void

unref

  • unref(): void

  • Returns void

unshift

  • unshift(chunk: string): void
  • unshift(chunk: Buffer): void

  • Parameters

    • chunk: string

    Returns void

  • Parameters

    Returns void

wrap

  • Parameters

    Returns ReadableStream

write

  • write(buffer: Buffer): boolean
  • write(buffer: Buffer, cb?: Function): boolean
  • write(str: string, cb?: Function): boolean
  • write(str: string, encoding?: string, cb?: Function): boolean
  • write(str: string, encoding?: string, fd?: string): boolean
  • write(data: any, encoding?: string, callback?: Function): void

  • Parameters

    Returns boolean

  • Parameters

    • buffer: Buffer
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional fd: string

    Returns boolean

  • Parameters

    • data: any
    • Optional encoding: string
    • Optional callback: Function

    Returns void

Static listenerCount

  • listenerCount(emitter: EventEmitter, event: string): number

  • Parameters

    Returns number

Socket

Socket:

constructor

  • Parameters

    Returns Socket

bufferSize

bufferSize: number

bytesRead

bytesRead: number

bytesWritten

bytesWritten: number

readable

readable: boolean

remoteAddress

remoteAddress: string

remotePort

remotePort: number

writable

writable: boolean

_read

  • _read(size: number): void

  • Parameters

    • size: number

    Returns void

_write

  • _write(data: Buffer, encoding: string, callback: Function): void
  • _write(data: string, encoding: string, callback: Function): void

  • Parameters

    • data: Buffer
    • encoding: string
    • callback: Function

    Returns void

  • Parameters

    • data: string
    • encoding: string
    • callback: Function

    Returns void

addListener

  • addListener(event: string, listener: Function): EventEmitter

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

address

  • address(): object

  • Returns object

    • address: string
    • family: string
    • port: number

connect

  • connect(port: number, host?: string, connectionListener?: Function): void
  • connect(path: string, connectionListener?: Function): void

  • Parameters

    • port: number
    • Optional host: string
    • Optional connectionListener: Function

    Returns void

  • Parameters

    • path: string
    • Optional connectionListener: Function

    Returns void

destroy

  • destroy(): void

  • Returns void

emit

  • emit(event: string, ...args: any[]): boolean

  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

end

  • end(): void
  • end(buffer: Buffer, cb?: Function): void
  • end(str: string, cb?: Function): void
  • end(str: string, encoding?: string, cb?: Function): void
  • end(data?: any, encoding?: string): void

  • Returns void

  • Parameters

    • buffer: Buffer
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns void

  • Parameters

    • Optional data: any
    • Optional encoding: string

    Returns void

listeners

  • listeners(event: string): Function[]

  • Parameters

    • event: string

    Returns Function[]

on

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

once

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

pause

  • pause(): void

  • Returns void

pipe

  • pipe<T>(destination: T, options?: object): T

  • Type parameters

    Parameters

    • destination: T
    • Optional options: object
      • Optional end?: boolean

    Returns T

push

  • push(chunk: any, encoding?: string): boolean

  • Parameters

    • chunk: any
    • Optional encoding: string

    Returns boolean

read

  • read(size?: number): any

  • Parameters

    • Optional size: number

    Returns any

ref

  • ref(): void

  • Returns void

removeAllListeners

  • Parameters

    • Optional event: string

    Returns EventEmitter

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

resume

  • resume(): void

  • Returns void

setEncoding

  • setEncoding(encoding?: string): void

  • Parameters

    • Optional encoding: string

    Returns void

setKeepAlive

  • setKeepAlive(enable?: boolean, initialDelay?: number): void

  • Parameters

    • Optional enable: boolean
    • Optional initialDelay: number

    Returns void

setMaxListeners

  • setMaxListeners(n: number): void

  • Parameters

    • n: number

    Returns void

setNoDelay

  • setNoDelay(noDelay?: boolean): void

  • Parameters

    • Optional noDelay: boolean

    Returns void

setTimeout

  • setTimeout(timeout: number, callback?: Function): void

  • Parameters

    • timeout: number
    • Optional callback: Function

    Returns void

unpipe

  • unpipe<T>(destination?: T): void

  • Type parameters

    Parameters

    • Optional destination: T

    Returns void

unref

  • unref(): void

  • Returns void

unshift

  • unshift(chunk: string): void
  • unshift(chunk: Buffer): void

  • Parameters

    • chunk: string

    Returns void

  • Parameters

    Returns void

wrap

  • Parameters

    Returns ReadableStream

write

  • write(buffer: Buffer): boolean
  • write(buffer: Buffer, cb?: Function): boolean
  • write(str: string, cb?: Function): boolean
  • write(str: string, encoding?: string, cb?: Function): boolean
  • write(str: string, encoding?: string, fd?: string): boolean
  • write(data: any, encoding?: string, callback?: Function): void

  • Parameters

    Returns boolean

  • Parameters

    • buffer: Buffer
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional fd: string

    Returns boolean

  • Parameters

    • data: any
    • Optional encoding: string
    • Optional callback: Function

    Returns void

Static listenerCount

  • listenerCount(emitter: EventEmitter, event: string): number

  • Parameters

    Returns number

connect

  • connect(options: object, connectionListener?: Function): Socket
  • connect(port: number, host?: string, connectionListener?: Function): Socket
  • connect(path: string, connectionListener?: Function): Socket

  • Parameters

    • options: object
      • Optional allowHalfOpen?: boolean
    • Optional connectionListener: Function

    Returns Socket

  • Parameters

    • port: number
    • Optional host: string
    • Optional connectionListener: Function

    Returns Socket

  • Parameters

    • path: string
    • Optional connectionListener: Function

    Returns Socket

createConnection

  • createConnection(options: object, connectionListener?: Function): Socket
  • createConnection(port: number, host?: string, connectionListener?: Function): Socket
  • createConnection(path: string, connectionListener?: Function): Socket

  • Parameters

    • options: object
      • Optional allowHalfOpen?: boolean
    • Optional connectionListener: Function

    Returns Socket

  • Parameters

    • port: number
    • Optional host: string
    • Optional connectionListener: Function

    Returns Socket

  • Parameters

    • path: string
    • Optional connectionListener: Function

    Returns Socket

createServer

  • createServer(connectionListener?: function): Server
  • createServer(options?: object, connectionListener?: function): Server

  • Parameters

    • Optional connectionListener: function

        • Parameters

          Returns void

    Returns Server

  • Parameters

    • Optional options: object
      • Optional allowHalfOpen?: boolean
    • Optional connectionListener: function

        • Parameters

          Returns void

    Returns Server

isIP

  • isIP(input: string): number

  • Parameters

    • input: string

    Returns number

isIPv4

  • isIPv4(input: string): boolean

  • Parameters

    • input: string

    Returns boolean

isIPv6

  • isIPv6(input: string): boolean

  • Parameters

    • input: string

    Returns boolean

"os"

"os":

EOL

EOL: string

arch

  • arch(): string

  • Returns string

cpus

  • cpus(): object[]

  • Returns object[]

    • model: string
    • speed: number
    • times: object
      • idle: number
      • irq: number
      • nice: number
      • sys: number
      • user: number

freemem

  • freemem(): number

  • Returns number

hostname

  • hostname(): string

  • Returns string

loadavg

  • loadavg(): number[]

  • Returns number[]

networkInterfaces

  • networkInterfaces(): any

  • Returns any

platform

  • platform(): string

  • Returns string

release

  • release(): string

  • Returns string

tmpdir

  • tmpdir(): string

  • Returns string

totalmem

  • totalmem(): number

  • Returns number

type

  • type(): string

  • Returns string

uptime

  • uptime(): number

  • Returns number

"path"

"path":

ParsedPath

ParsedPath:

base

base: string

dir

dir: string

ext

ext: string

name

name: string

root

root: string

delimiter

delimiter: string

sep

sep: string

basename

  • basename(p: string, ext?: string): string

  • Parameters

    • p: string
    • Optional ext: string

    Returns string

dirname

  • dirname(p: string): string

  • Parameters

    • p: string

    Returns string

extname

  • extname(p: string): string

  • Parameters

    • p: string

    Returns string

format

  • Parameters

    Returns string

isAbsolute

  • isAbsolute(p: string): boolean

  • Parameters

    • p: string

    Returns boolean

join

  • join(...paths: any[]): string

  • Parameters

    • Rest ...paths: any[]

    Returns string

normalize

  • normalize(p: string): string

  • Parameters

    • p: string

    Returns string

parse

  • Parameters

    • p: string

    Returns ParsedPath

relative

  • relative(from: string, to: string): string

  • Parameters

    • from: string
    • to: string

    Returns string

resolve

  • resolve(...pathSegments: any[]): string

  • Parameters

    • Rest ...pathSegments: any[]

    Returns string

"punycode"

"punycode":

ucs2

ucs2:

decode

  • decode(string: string): string

  • Parameters

    • string: string

    Returns string

encode

  • encode(codePoints: number[]): string

  • Parameters

    • codePoints: number[]

    Returns string

version

version: any

decode

  • decode(string: string): string

  • Parameters

    • string: string

    Returns string

encode

  • encode(string: string): string

  • Parameters

    • string: string

    Returns string

toASCII

  • toASCII(domain: string): string

  • Parameters

    • domain: string

    Returns string

toUnicode

  • toUnicode(domain: string): string

  • Parameters

    • domain: string

    Returns string

"querystring"

"querystring":

escape

  • escape(str: string): string

  • Parameters

    • str: string

    Returns string

parse

  • parse(str: string, sep?: string, eq?: string, options?: object): any

  • Parameters

    • str: string
    • Optional sep: string
    • Optional eq: string
    • Optional options: object
      • Optional maxKeys?: number

    Returns any

stringify

  • stringify(obj: any, sep?: string, eq?: string): string

  • Parameters

    • obj: any
    • Optional sep: string
    • Optional eq: string

    Returns string

unescape

  • unescape(str: string): string

  • Parameters

    • str: string

    Returns string

"readline"

"readline":

ReadLine

ReadLine:

addListener

  • addListener(event: string, listener: Function): EventEmitter

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

close

  • close(): void

  • Returns void

emit

  • emit(event: string, ...args: any[]): boolean

  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

listeners

  • listeners(event: string): Function[]

  • Parameters

    • event: string

    Returns Function[]

on

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

once

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

pause

  • pause(): void

  • Returns void

prompt

  • prompt(preserveCursor?: boolean): void

  • Parameters

    • Optional preserveCursor: boolean

    Returns void

question

  • question(query: string, callback: Function): void

  • Parameters

    • query: string
    • callback: Function

    Returns void

removeAllListeners

  • Parameters

    • Optional event: string

    Returns EventEmitter

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

resume

  • resume(): void

  • Returns void

setMaxListeners

  • setMaxListeners(n: number): void

  • Parameters

    • n: number

    Returns void

setPrompt

  • setPrompt(prompt: string, length: number): void

  • Parameters

    • prompt: string
    • length: number

    Returns void

write

  • write(data: any, key?: any): void

  • Parameters

    • data: any
    • Optional key: any

    Returns void

Static listenerCount

  • listenerCount(emitter: EventEmitter, event: string): number

  • Parameters

    Returns number

ReadLineOptions

ReadLineOptions:

Optional completer

completer: Function

input

input: ReadableStream

output

output: WritableStream

Optional terminal

terminal: boolean

createInterface

"repl"

"repl":

ReplOptions

ReplOptions:

Optional eval

eval: Function

Optional ignoreUndefined

ignoreUndefined: boolean

Optional input

input: ReadableStream

Optional output

output: WritableStream

Optional prompt

prompt: string

Optional terminal

terminal: boolean

Optional useColors

useColors: boolean

Optional useGlobal

useGlobal: boolean

Optional writer

writer: Function

start

"stream"

"stream":

Duplex

Duplex:

constructor

  • Parameters

    Returns Duplex

readable

readable: boolean

writable

writable: boolean

_read

  • _read(size: number): void

  • Parameters

    • size: number

    Returns void

_write

  • _write(data: Buffer, encoding: string, callback: Function): void
  • _write(data: string, encoding: string, callback: Function): void

  • Parameters

    • data: Buffer
    • encoding: string
    • callback: Function

    Returns void

  • Parameters

    • data: string
    • encoding: string
    • callback: Function

    Returns void

addListener

  • addListener(event: string, listener: Function): EventEmitter

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

emit

  • emit(event: string, ...args: any[]): boolean

  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

end

  • end(): void
  • end(buffer: Buffer, cb?: Function): void
  • end(str: string, cb?: Function): void
  • end(str: string, encoding?: string, cb?: Function): void

  • Returns void

  • Parameters

    • buffer: Buffer
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns void

listeners

  • listeners(event: string): Function[]

  • Parameters

    • event: string

    Returns Function[]

on

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

once

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

pause

  • pause(): void

  • Returns void

pipe

  • pipe<T>(destination: T, options?: object): T

  • Type parameters

    Parameters

    • destination: T
    • Optional options: object
      • Optional end?: boolean

    Returns T

push

  • push(chunk: any, encoding?: string): boolean

  • Parameters

    • chunk: any
    • Optional encoding: string

    Returns boolean

read

  • read(size?: number): any

  • Parameters

    • Optional size: number

    Returns any

removeAllListeners

  • Parameters

    • Optional event: string

    Returns EventEmitter

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

resume

  • resume(): void

  • Returns void

setEncoding

  • setEncoding(encoding: string): void

  • Parameters

    • encoding: string

    Returns void

setMaxListeners

  • setMaxListeners(n: number): void

  • Parameters

    • n: number

    Returns void

unpipe

  • unpipe<T>(destination?: T): void

  • Type parameters

    Parameters

    • Optional destination: T

    Returns void

unshift

  • unshift(chunk: string): void
  • unshift(chunk: Buffer): void

  • Parameters

    • chunk: string

    Returns void

  • Parameters

    Returns void

wrap

  • Parameters

    Returns ReadableStream

write

  • write(buffer: Buffer, cb?: Function): boolean
  • write(str: string, cb?: Function): boolean
  • write(str: string, encoding?: string, cb?: Function): boolean

  • Parameters

    • buffer: Buffer
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns boolean

Static listenerCount

  • listenerCount(emitter: EventEmitter, event: string): number

  • Parameters

    Returns number

PassThrough

PassThrough:

constructor

  • Parameters

    Returns PassThrough

readable

readable: boolean

writable

writable: boolean

_flush

  • _flush(callback: Function): void

  • Parameters

    • callback: Function

    Returns void

_transform

  • _transform(chunk: Buffer, encoding: string, callback: Function): void
  • _transform(chunk: string, encoding: string, callback: Function): void

  • Parameters

    • chunk: Buffer
    • encoding: string
    • callback: Function

    Returns void

  • Parameters

    • chunk: string
    • encoding: string
    • callback: Function

    Returns void

addListener

  • addListener(event: string, listener: Function): EventEmitter

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

emit

  • emit(event: string, ...args: any[]): boolean

  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

end

  • end(): void
  • end(buffer: Buffer, cb?: Function): void
  • end(str: string, cb?: Function): void
  • end(str: string, encoding?: string, cb?: Function): void

  • Returns void

  • Parameters

    • buffer: Buffer
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns void

listeners

  • listeners(event: string): Function[]

  • Parameters

    • event: string

    Returns Function[]

on

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

once

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

pause

  • pause(): void

  • Returns void

pipe

  • pipe<T>(destination: T, options?: object): T

  • Type parameters

    Parameters

    • destination: T
    • Optional options: object
      • Optional end?: boolean

    Returns T

push

  • push(chunk: any, encoding?: string): boolean

  • Parameters

    • chunk: any
    • Optional encoding: string

    Returns boolean

read

  • read(size?: number): any

  • Parameters

    • Optional size: number

    Returns any

removeAllListeners

  • Parameters

    • Optional event: string

    Returns EventEmitter

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

resume

  • resume(): void

  • Returns void

setEncoding

  • setEncoding(encoding: string): void

  • Parameters

    • encoding: string

    Returns void

setMaxListeners

  • setMaxListeners(n: number): void

  • Parameters

    • n: number

    Returns void

unpipe

  • unpipe<T>(destination?: T): void

  • Type parameters

    Parameters

    • Optional destination: T

    Returns void

unshift

  • unshift(chunk: string): void
  • unshift(chunk: Buffer): void

  • Parameters

    • chunk: string

    Returns void

  • Parameters

    Returns void

wrap

  • Parameters

    Returns ReadableStream

write

  • write(buffer: Buffer, cb?: Function): boolean
  • write(str: string, cb?: Function): boolean
  • write(str: string, encoding?: string, cb?: Function): boolean

  • Parameters

    • buffer: Buffer
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns boolean

Static listenerCount

  • listenerCount(emitter: EventEmitter, event: string): number

  • Parameters

    Returns number

Readable

Readable:

constructor

readable

readable: boolean

_read

  • _read(size: number): void

  • Parameters

    • size: number

    Returns void

addListener

  • addListener(event: string, listener: Function): EventEmitter

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

emit

  • emit(event: string, ...args: any[]): boolean

  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

listeners

  • listeners(event: string): Function[]

  • Parameters

    • event: string

    Returns Function[]

on

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

once

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

pause

  • pause(): void

  • Returns void

pipe

  • pipe<T>(destination: T, options?: object): T

  • Type parameters

    Parameters

    • destination: T
    • Optional options: object
      • Optional end?: boolean

    Returns T

push

  • push(chunk: any, encoding?: string): boolean

  • Parameters

    • chunk: any
    • Optional encoding: string

    Returns boolean

read

  • read(size?: number): any

  • Parameters

    • Optional size: number

    Returns any

removeAllListeners

  • Parameters

    • Optional event: string

    Returns EventEmitter

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

resume

  • resume(): void

  • Returns void

setEncoding

  • setEncoding(encoding: string): void

  • Parameters

    • encoding: string

    Returns void

setMaxListeners

  • setMaxListeners(n: number): void

  • Parameters

    • n: number

    Returns void

unpipe

  • unpipe<T>(destination?: T): void

  • Type parameters

    Parameters

    • Optional destination: T

    Returns void

unshift

  • unshift(chunk: string): void
  • unshift(chunk: Buffer): void

  • Parameters

    • chunk: string

    Returns void

  • Parameters

    Returns void

wrap

  • Parameters

    Returns ReadableStream

Static listenerCount

  • listenerCount(emitter: EventEmitter, event: string): number

  • Parameters

    Returns number

Transform

Transform:

constructor

readable

readable: boolean

writable

writable: boolean

_flush

  • _flush(callback: Function): void

  • Parameters

    • callback: Function

    Returns void

_transform

  • _transform(chunk: Buffer, encoding: string, callback: Function): void
  • _transform(chunk: string, encoding: string, callback: Function): void

  • Parameters

    • chunk: Buffer
    • encoding: string
    • callback: Function

    Returns void

  • Parameters

    • chunk: string
    • encoding: string
    • callback: Function

    Returns void

addListener

  • addListener(event: string, listener: Function): EventEmitter

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

emit

  • emit(event: string, ...args: any[]): boolean

  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

end

  • end(): void
  • end(buffer: Buffer, cb?: Function): void
  • end(str: string, cb?: Function): void
  • end(str: string, encoding?: string, cb?: Function): void

  • Returns void

  • Parameters

    • buffer: Buffer
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns void

listeners

  • listeners(event: string): Function[]

  • Parameters

    • event: string

    Returns Function[]

on

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

once

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

pause

  • pause(): void

  • Returns void

pipe

  • pipe<T>(destination: T, options?: object): T

  • Type parameters

    Parameters

    • destination: T
    • Optional options: object
      • Optional end?: boolean

    Returns T

push

  • push(chunk: any, encoding?: string): boolean

  • Parameters

    • chunk: any
    • Optional encoding: string

    Returns boolean

read

  • read(size?: number): any

  • Parameters

    • Optional size: number

    Returns any

removeAllListeners

  • Parameters

    • Optional event: string

    Returns EventEmitter

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

resume

  • resume(): void

  • Returns void

setEncoding

  • setEncoding(encoding: string): void

  • Parameters

    • encoding: string

    Returns void

setMaxListeners

  • setMaxListeners(n: number): void

  • Parameters

    • n: number

    Returns void

unpipe

  • unpipe<T>(destination?: T): void

  • Type parameters

    Parameters

    • Optional destination: T

    Returns void

unshift

  • unshift(chunk: string): void
  • unshift(chunk: Buffer): void

  • Parameters

    • chunk: string

    Returns void

  • Parameters

    Returns void

wrap

  • Parameters

    Returns ReadableStream

write

  • write(buffer: Buffer, cb?: Function): boolean
  • write(str: string, cb?: Function): boolean
  • write(str: string, encoding?: string, cb?: Function): boolean

  • Parameters

    • buffer: Buffer
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns boolean

Static listenerCount

  • listenerCount(emitter: EventEmitter, event: string): number

  • Parameters

    Returns number

Writable

Writable:

constructor

writable

writable: boolean

_write

  • _write(data: Buffer, encoding: string, callback: Function): void
  • _write(data: string, encoding: string, callback: Function): void

  • Parameters

    • data: Buffer
    • encoding: string
    • callback: Function

    Returns void

  • Parameters

    • data: string
    • encoding: string
    • callback: Function

    Returns void

addListener

  • addListener(event: string, listener: Function): EventEmitter

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

emit

  • emit(event: string, ...args: any[]): boolean

  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

end

  • end(): void
  • end(buffer: Buffer, cb?: Function): void
  • end(str: string, cb?: Function): void
  • end(str: string, encoding?: string, cb?: Function): void

  • Returns void

  • Parameters

    • buffer: Buffer
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns void

listeners

  • listeners(event: string): Function[]

  • Parameters

    • event: string

    Returns Function[]

on

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

once

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

removeAllListeners

  • Parameters

    • Optional event: string

    Returns EventEmitter

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

setMaxListeners

  • setMaxListeners(n: number): void

  • Parameters

    • n: number

    Returns void

write

  • write(buffer: Buffer, cb?: Function): boolean
  • write(str: string, cb?: Function): boolean
  • write(str: string, encoding?: string, cb?: Function): boolean

  • Parameters

    • buffer: Buffer
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns boolean

Static listenerCount

  • listenerCount(emitter: EventEmitter, event: string): number

  • Parameters

    Returns number

DuplexOptions

DuplexOptions:

Optional allowHalfOpen

allowHalfOpen: boolean

Optional decodeStrings

decodeStrings: boolean

Optional encoding

encoding: string

Optional highWaterMark

highWaterMark: number

Optional objectMode

objectMode: boolean

ReadableOptions

ReadableOptions:

Optional encoding

encoding: string

Optional highWaterMark

highWaterMark: number

Optional objectMode

objectMode: boolean

Stream

Stream:

addListener

  • addListener(event: string, listener: Function): EventEmitter

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

emit

  • emit(event: string, ...args: any[]): boolean

  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

listeners

  • listeners(event: string): Function[]

  • Parameters

    • event: string

    Returns Function[]

on

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

once

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

pipe

  • pipe<T>(destination: T, options?: object): T

  • Type parameters

    Parameters

    • destination: T
    • Optional options: object
      • Optional end?: boolean

    Returns T

removeAllListeners

  • Parameters

    • Optional event: string

    Returns EventEmitter

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

setMaxListeners

  • setMaxListeners(n: number): void

  • Parameters

    • n: number

    Returns void

Static listenerCount

  • listenerCount(emitter: EventEmitter, event: string): number

  • Parameters

    Returns number

TransformOptions

TransformOptions:

Optional decodeStrings

decodeStrings: boolean

Optional encoding

encoding: string

Optional highWaterMark

highWaterMark: number

Optional objectMode

objectMode: boolean

WritableOptions

WritableOptions:

Optional decodeStrings

decodeStrings: boolean

Optional highWaterMark

highWaterMark: number

"string_decoder"

"string_decoder":

NodeStringDecoder

NodeStringDecoder:

detectIncompleteChar

  • detectIncompleteChar(buffer: Buffer): number

  • Parameters

    Returns number

write

  • write(buffer: Buffer): string

  • Parameters

    Returns string

StringDecoder

StringDecoder: object

Type declaration

  • constructor: function
    • new __type(encoding: string): __type

    • Parameters

      • encoding: string

      Returns __type

"tls"

"tls":

ClearTextStream

ClearTextStream:

constructor

  • Parameters

    Returns ClearTextStream

address

address: object

Type declaration

  • address: string
  • family: string
  • port: number

authorizationError

authorizationError: Error

authorized

authorized: boolean

getCipher

getCipher: object

Type declaration

  • name: string
  • version: string

readable

readable: boolean

remoteAddress

remoteAddress: string

remotePort

remotePort: number

writable

writable: boolean

_read

  • _read(size: number): void

  • Parameters

    • size: number

    Returns void

_write

  • _write(data: Buffer, encoding: string, callback: Function): void
  • _write(data: string, encoding: string, callback: Function): void

  • Parameters

    • data: Buffer
    • encoding: string
    • callback: Function

    Returns void

  • Parameters

    • data: string
    • encoding: string
    • callback: Function

    Returns void

addListener

  • addListener(event: string, listener: Function): EventEmitter

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

emit

  • emit(event: string, ...args: any[]): boolean

  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

end

  • end(): void
  • end(buffer: Buffer, cb?: Function): void
  • end(str: string, cb?: Function): void
  • end(str: string, encoding?: string, cb?: Function): void

  • Returns void

  • Parameters

    • buffer: Buffer
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns void

getPeerCertificate

  • getPeerCertificate(): any

  • Returns any

listeners

  • listeners(event: string): Function[]

  • Parameters

    • event: string

    Returns Function[]

on

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

once

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

pause

  • pause(): void

  • Returns void

pipe

  • pipe<T>(destination: T, options?: object): T

  • Type parameters

    Parameters

    • destination: T
    • Optional options: object
      • Optional end?: boolean

    Returns T

push

  • push(chunk: any, encoding?: string): boolean

  • Parameters

    • chunk: any
    • Optional encoding: string

    Returns boolean

read

  • read(size?: number): any

  • Parameters

    • Optional size: number

    Returns any

removeAllListeners

  • Parameters

    • Optional event: string

    Returns EventEmitter

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

resume

  • resume(): void

  • Returns void

setEncoding

  • setEncoding(encoding: string): void

  • Parameters

    • encoding: string

    Returns void

setMaxListeners

  • setMaxListeners(n: number): void

  • Parameters

    • n: number

    Returns void

unpipe

  • unpipe<T>(destination?: T): void

  • Type parameters

    Parameters

    • Optional destination: T

    Returns void

unshift

  • unshift(chunk: string): void
  • unshift(chunk: Buffer): void

  • Parameters

    • chunk: string

    Returns void

  • Parameters

    Returns void

wrap

  • Parameters

    Returns ReadableStream

write

  • write(buffer: Buffer, cb?: Function): boolean
  • write(str: string, cb?: Function): boolean
  • write(str: string, encoding?: string, cb?: Function): boolean

  • Parameters

    • buffer: Buffer
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns boolean

Static listenerCount

  • listenerCount(emitter: EventEmitter, event: string): number

  • Parameters

    Returns number

ConnectionOptions

ConnectionOptions:

Optional NPNProtocols

NPNProtocols: any

Optional ca

ca: any

Optional cert

cert: any

Optional host

host: string

Optional key

key: any

Optional passphrase

passphrase: string

Optional pfx

pfx: any

Optional port

port: number

Optional rejectUnauthorized

rejectUnauthorized: boolean

Optional servername

servername: string

Optional socket

socket: Socket

SecurePair

SecurePair:

cleartext

cleartext: any

encrypted

encrypted: any

Server

Server:

constructor

  • Parameters

    Returns Server

bufferSize

bufferSize: number

bytesRead

bytesRead: number

bytesWritten

bytesWritten: number

connections

connections: number

maxConnections

maxConnections: number

readable

readable: boolean

remoteAddress

remoteAddress: string

remotePort

remotePort: number

writable

writable: boolean

_read

  • _read(size: number): void

  • Parameters

    • size: number

    Returns void

_write

  • _write(data: Buffer, encoding: string, callback: Function): void
  • _write(data: string, encoding: string, callback: Function): void

  • Parameters

    • data: Buffer
    • encoding: string
    • callback: Function

    Returns void

  • Parameters

    • data: string
    • encoding: string
    • callback: Function

    Returns void

addContext

  • addContext(hostName: string, credentials: object): void

  • Parameters

    • hostName: string
    • credentials: object
      • ca: string
      • cert: string
      • key: string

    Returns void

addListener

  • addListener(event: string, listener: Function): EventEmitter

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

address

  • address(): object

  • Returns object

    • address: string
    • family: string
    • port: number

close

  • Returns Server

connect

  • connect(port: number, host?: string, connectionListener?: Function): void
  • connect(path: string, connectionListener?: Function): void

  • Parameters

    • port: number
    • Optional host: string
    • Optional connectionListener: Function

    Returns void

  • Parameters

    • path: string
    • Optional connectionListener: Function

    Returns void

destroy

  • destroy(): void

  • Returns void

emit

  • emit(event: string, ...args: any[]): boolean

  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

end

  • end(): void
  • end(buffer: Buffer, cb?: Function): void
  • end(str: string, cb?: Function): void
  • end(str: string, encoding?: string, cb?: Function): void
  • end(data?: any, encoding?: string): void

  • Returns void

  • Parameters

    • buffer: Buffer
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns void

  • Parameters

    • Optional data: any
    • Optional encoding: string

    Returns void

listen

  • listen(port: number, host?: string, backlog?: number, listeningListener?: Function): Server
  • listen(path: string, listeningListener?: Function): Server
  • listen(handle: any, listeningListener?: Function): Server
  • listen(port: number, host?: string, callback?: Function): Server

  • Parameters

    • port: number
    • Optional host: string
    • Optional backlog: number
    • Optional listeningListener: Function

    Returns Server

  • Parameters

    • path: string
    • Optional listeningListener: Function

    Returns Server

  • Parameters

    • handle: any
    • Optional listeningListener: Function

    Returns Server

  • Parameters

    • port: number
    • Optional host: string
    • Optional callback: Function

    Returns Server

listeners

  • listeners(event: string): Function[]

  • Parameters

    • event: string

    Returns Function[]

on

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

once

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

pause

  • pause(): void

  • Returns void

pipe

  • pipe<T>(destination: T, options?: object): T

  • Type parameters

    Parameters

    • destination: T
    • Optional options: object
      • Optional end?: boolean

    Returns T

push

  • push(chunk: any, encoding?: string): boolean

  • Parameters

    • chunk: any
    • Optional encoding: string

    Returns boolean

read

  • read(size?: number): any

  • Parameters

    • Optional size: number

    Returns any

ref

  • ref(): void

  • Returns void

removeAllListeners

  • Parameters

    • Optional event: string

    Returns EventEmitter

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

resume

  • resume(): void

  • Returns void

setEncoding

  • setEncoding(encoding?: string): void

  • Parameters

    • Optional encoding: string

    Returns void

setKeepAlive

  • setKeepAlive(enable?: boolean, initialDelay?: number): void

  • Parameters

    • Optional enable: boolean
    • Optional initialDelay: number

    Returns void

setMaxListeners

  • setMaxListeners(n: number): void

  • Parameters

    • n: number

    Returns void

setNoDelay

  • setNoDelay(noDelay?: boolean): void

  • Parameters

    • Optional noDelay: boolean

    Returns void

setTimeout

  • setTimeout(timeout: number, callback?: Function): void

  • Parameters

    • timeout: number
    • Optional callback: Function

    Returns void

unpipe

  • unpipe<T>(destination?: T): void

  • Type parameters

    Parameters

    • Optional destination: T

    Returns void

unref

  • unref(): void

  • Returns void

unshift

  • unshift(chunk: string): void
  • unshift(chunk: Buffer): void

  • Parameters

    • chunk: string

    Returns void

  • Parameters

    Returns void

wrap

  • Parameters

    Returns ReadableStream

write

  • write(buffer: Buffer): boolean
  • write(buffer: Buffer, cb?: Function): boolean
  • write(str: string, cb?: Function): boolean
  • write(str: string, encoding?: string, cb?: Function): boolean
  • write(str: string, encoding?: string, fd?: string): boolean
  • write(data: any, encoding?: string, callback?: Function): void

  • Parameters

    Returns boolean

  • Parameters

    • buffer: Buffer
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional fd: string

    Returns boolean

  • Parameters

    • data: any
    • Optional encoding: string
    • Optional callback: Function

    Returns void

Static listenerCount

  • listenerCount(emitter: EventEmitter, event: string): number

  • Parameters

    Returns number

TlsOptions

TlsOptions:

Optional NPNProtocols

NPNProtocols: any

Optional SNICallback

SNICallback: function

Type declaration

    • (servername: string): any

    • Parameters

      • servername: string

      Returns any

Optional ca

ca: any

Optional cert

cert: any

Optional ciphers

ciphers: string

Optional crl

crl: any

Optional honorCipherOrder

honorCipherOrder: any

Optional key

key: any

Optional passphrase

passphrase: string

Optional pfx

pfx: any

Optional rejectUnauthorized

rejectUnauthorized: boolean

Optional requestCert

requestCert: boolean

CLIENT_RENEG_LIMIT

CLIENT_RENEG_LIMIT: number

CLIENT_RENEG_WINDOW

CLIENT_RENEG_WINDOW: number

connect

  • Parameters

    • options: TlsOptions
    • Optional secureConnectionListener: function
        • (): void

        • Returns void

    Returns ClearTextStream

  • Parameters

    • port: number
    • Optional host: string
    • Optional options: ConnectionOptions
    • Optional secureConnectListener: function
        • (): void

        • Returns void

    Returns ClearTextStream

  • Parameters

    • port: number
    • Optional options: ConnectionOptions
    • Optional secureConnectListener: function
        • (): void

        • Returns void

    Returns ClearTextStream

createSecurePair

  • createSecurePair(credentials?: Credentials, isServer?: boolean, requestCert?: boolean, rejectUnauthorized?: boolean): SecurePair

  • Parameters

    • Optional credentials: Credentials
    • Optional isServer: boolean
    • Optional requestCert: boolean
    • Optional rejectUnauthorized: boolean

    Returns SecurePair

createServer

  • createServer(options: TlsOptions, secureConnectionListener?: function): Server

  • Parameters

    Returns Server

"tty"

"tty":

ReadStream

ReadStream:

constructor

  • Parameters

    Returns ReadStream

Socket

Socket: object

Type declaration

  • constructor: function
    • new __type(options?: object): __type

    • Parameters

      • Optional options: object
        • Optional allowHalfOpen?: boolean
        • Optional fd?: string
        • Optional type?: string

      Returns __type

bufferSize

bufferSize: number

bytesRead

bytesRead: number

bytesWritten

bytesWritten: number

isRaw

isRaw: boolean

readable

readable: boolean

remoteAddress

remoteAddress: string

remotePort

remotePort: number

writable

writable: boolean

_read

  • _read(size: number): void

  • Parameters

    • size: number

    Returns void

_write

  • _write(data: Buffer, encoding: string, callback: Function): void
  • _write(data: string, encoding: string, callback: Function): void

  • Parameters

    • data: Buffer
    • encoding: string
    • callback: Function

    Returns void

  • Parameters

    • data: string
    • encoding: string
    • callback: Function

    Returns void

addListener

  • addListener(event: string, listener: Function): EventEmitter

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

address

  • address(): object

  • Returns object

    • address: string
    • family: string
    • port: number

connect

  • connect(port: number, host?: string, connectionListener?: Function): void
  • connect(path: string, connectionListener?: Function): void

  • Parameters

    • port: number
    • Optional host: string
    • Optional connectionListener: Function

    Returns void

  • Parameters

    • path: string
    • Optional connectionListener: Function

    Returns void

destroy

  • destroy(): void

  • Returns void

emit

  • emit(event: string, ...args: any[]): boolean

  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

end

  • end(): void
  • end(buffer: Buffer, cb?: Function): void
  • end(str: string, cb?: Function): void
  • end(str: string, encoding?: string, cb?: Function): void
  • end(data?: any, encoding?: string): void

  • Returns void

  • Parameters

    • buffer: Buffer
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns void

  • Parameters

    • Optional data: any
    • Optional encoding: string

    Returns void

listeners

  • listeners(event: string): Function[]

  • Parameters

    • event: string

    Returns Function[]

on

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

once

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

pause

  • pause(): void

  • Returns void

pipe

  • pipe<T>(destination: T, options?: object): T

  • Type parameters

    Parameters

    • destination: T
    • Optional options: object
      • Optional end?: boolean

    Returns T

push

  • push(chunk: any, encoding?: string): boolean

  • Parameters

    • chunk: any
    • Optional encoding: string

    Returns boolean

read

  • read(size?: number): any

  • Parameters

    • Optional size: number

    Returns any

ref

  • ref(): void

  • Returns void

removeAllListeners

  • Parameters

    • Optional event: string

    Returns EventEmitter

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

resume

  • resume(): void

  • Returns void

setEncoding

  • setEncoding(encoding?: string): void

  • Parameters

    • Optional encoding: string

    Returns void

setKeepAlive

  • setKeepAlive(enable?: boolean, initialDelay?: number): void

  • Parameters

    • Optional enable: boolean
    • Optional initialDelay: number

    Returns void

setMaxListeners

  • setMaxListeners(n: number): void

  • Parameters

    • n: number

    Returns void

setNoDelay

  • setNoDelay(noDelay?: boolean): void

  • Parameters

    • Optional noDelay: boolean

    Returns void

setRawMode

  • setRawMode(mode: boolean): void

  • Parameters

    • mode: boolean

    Returns void

setTimeout

  • setTimeout(timeout: number, callback?: Function): void

  • Parameters

    • timeout: number
    • Optional callback: Function

    Returns void

unpipe

  • unpipe<T>(destination?: T): void

  • Type parameters

    Parameters

    • Optional destination: T

    Returns void

unref

  • unref(): void

  • Returns void

unshift

  • unshift(chunk: string): void
  • unshift(chunk: Buffer): void

  • Parameters

    • chunk: string

    Returns void

  • Parameters

    Returns void

wrap

  • Parameters

    Returns ReadableStream

write

  • write(buffer: Buffer): boolean
  • write(buffer: Buffer, cb?: Function): boolean
  • write(str: string, cb?: Function): boolean
  • write(str: string, encoding?: string, cb?: Function): boolean
  • write(str: string, encoding?: string, fd?: string): boolean
  • write(data: any, encoding?: string, callback?: Function): void

  • Parameters

    Returns boolean

  • Parameters

    • buffer: Buffer
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional fd: string

    Returns boolean

  • Parameters

    • data: any
    • Optional encoding: string
    • Optional callback: Function

    Returns void

Static listenerCount

  • listenerCount(emitter: EventEmitter, event: string): number

  • Parameters

    Returns number

WriteStream

WriteStream:

constructor

  • Parameters

    Returns WriteStream

Socket

Socket: object

Type declaration

  • constructor: function
    • new __type(options?: object): __type

    • Parameters

      • Optional options: object
        • Optional allowHalfOpen?: boolean
        • Optional fd?: string
        • Optional type?: string

      Returns __type

bufferSize

bufferSize: number

bytesRead

bytesRead: number

bytesWritten

bytesWritten: number

columns

columns: number

readable

readable: boolean

remoteAddress

remoteAddress: string

remotePort

remotePort: number

rows

rows: number

writable

writable: boolean

_read

  • _read(size: number): void

  • Parameters

    • size: number

    Returns void

_write

  • _write(data: Buffer, encoding: string, callback: Function): void
  • _write(data: string, encoding: string, callback: Function): void

  • Parameters

    • data: Buffer
    • encoding: string
    • callback: Function

    Returns void

  • Parameters

    • data: string
    • encoding: string
    • callback: Function

    Returns void

addListener

  • addListener(event: string, listener: Function): EventEmitter

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

address

  • address(): object

  • Returns object

    • address: string
    • family: string
    • port: number

connect

  • connect(port: number, host?: string, connectionListener?: Function): void
  • connect(path: string, connectionListener?: Function): void

  • Parameters

    • port: number
    • Optional host: string
    • Optional connectionListener: Function

    Returns void

  • Parameters

    • path: string
    • Optional connectionListener: Function

    Returns void

destroy

  • destroy(): void

  • Returns void

emit

  • emit(event: string, ...args: any[]): boolean

  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

end

  • end(): void
  • end(buffer: Buffer, cb?: Function): void
  • end(str: string, cb?: Function): void
  • end(str: string, encoding?: string, cb?: Function): void
  • end(data?: any, encoding?: string): void

  • Returns void

  • Parameters

    • buffer: Buffer
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns void

  • Parameters

    • Optional data: any
    • Optional encoding: string

    Returns void

listeners

  • listeners(event: string): Function[]

  • Parameters

    • event: string

    Returns Function[]

on

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

once

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

pause

  • pause(): void

  • Returns void

pipe

  • pipe<T>(destination: T, options?: object): T

  • Type parameters

    Parameters

    • destination: T
    • Optional options: object
      • Optional end?: boolean

    Returns T

push

  • push(chunk: any, encoding?: string): boolean

  • Parameters

    • chunk: any
    • Optional encoding: string

    Returns boolean

read

  • read(size?: number): any

  • Parameters

    • Optional size: number

    Returns any

ref

  • ref(): void

  • Returns void

removeAllListeners

  • Parameters

    • Optional event: string

    Returns EventEmitter

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

resume

  • resume(): void

  • Returns void

setEncoding

  • setEncoding(encoding?: string): void

  • Parameters

    • Optional encoding: string

    Returns void

setKeepAlive

  • setKeepAlive(enable?: boolean, initialDelay?: number): void

  • Parameters

    • Optional enable: boolean
    • Optional initialDelay: number

    Returns void

setMaxListeners

  • setMaxListeners(n: number): void

  • Parameters

    • n: number

    Returns void

setNoDelay

  • setNoDelay(noDelay?: boolean): void

  • Parameters

    • Optional noDelay: boolean

    Returns void

setTimeout

  • setTimeout(timeout: number, callback?: Function): void

  • Parameters

    • timeout: number
    • Optional callback: Function

    Returns void

unpipe

  • unpipe<T>(destination?: T): void

  • Type parameters

    Parameters

    • Optional destination: T

    Returns void

unref

  • unref(): void

  • Returns void

unshift

  • unshift(chunk: string): void
  • unshift(chunk: Buffer): void

  • Parameters

    • chunk: string

    Returns void

  • Parameters

    Returns void

wrap

  • Parameters

    Returns ReadableStream

write

  • write(buffer: Buffer): boolean
  • write(buffer: Buffer, cb?: Function): boolean
  • write(str: string, cb?: Function): boolean
  • write(str: string, encoding?: string, cb?: Function): boolean
  • write(str: string, encoding?: string, fd?: string): boolean
  • write(data: any, encoding?: string, callback?: Function): void

  • Parameters

    Returns boolean

  • Parameters

    • buffer: Buffer
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional fd: string

    Returns boolean

  • Parameters

    • data: any
    • Optional encoding: string
    • Optional callback: Function

    Returns void

Static listenerCount

  • listenerCount(emitter: EventEmitter, event: string): number

  • Parameters

    Returns number

isatty

  • isatty(fd: number): boolean

  • Parameters

    • fd: number

    Returns boolean

"url"

"url":

Url

Url:

auth

auth: string

Optional hash

hash: string

host

host: string

hostname

hostname: string

href

href: string

Optional path

path: string

pathname

pathname: string

port

port: string

protocol

protocol: string

query

query: any

search

search: string

slashes

slashes: boolean

UrlOptions

UrlOptions:

Optional auth

auth: string

Optional hash

hash: string

Optional host

host: string

Optional hostname

hostname: string

Optional path

path: string

Optional pathname

pathname: string

Optional port

port: string

Optional protocol

protocol: string

Optional query

query: any

Optional search

search: string

format

  • Parameters

    Returns string

parse

  • parse(urlStr: string, parseQueryString?: boolean, slashesDenoteHost?: boolean): Url

  • Parameters

    • urlStr: string
    • Optional parseQueryString: boolean
    • Optional slashesDenoteHost: boolean

    Returns Url

resolve

  • resolve(from: string, to: string): string

  • Parameters

    • from: string
    • to: string

    Returns string

"util"

"util":

InspectOptions

InspectOptions:

Optional colors

colors: boolean

Optional customInspect

customInspect: boolean

Optional depth

depth: number

Optional showHidden

showHidden: boolean

debug

  • debug(string: string): void

  • Parameters

    • string: string

    Returns void

error

  • error(...param: any[]): void

  • Parameters

    • Rest ...param: any[]

    Returns void

format

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

  • Parameters

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

    Returns string

inherits

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

  • Parameters

    • constructor: any
    • superConstructor: any

    Returns void

inspect

  • inspect(object: any, showHidden?: boolean, depth?: number, color?: boolean): string
  • inspect(object: any, options: InspectOptions): string

  • Parameters

    • object: any
    • Optional showHidden: boolean
    • Optional depth: number
    • Optional color: boolean

    Returns string

  • Parameters

    Returns string

isArray

  • isArray(object: any): boolean

  • Parameters

    • object: any

    Returns boolean

isDate

  • isDate(object: any): boolean

  • Parameters

    • object: any

    Returns boolean

isError

  • isError(object: any): boolean

  • Parameters

    • object: any

    Returns boolean

isRegExp

  • isRegExp(object: any): boolean

  • Parameters

    • object: any

    Returns boolean

log

  • log(string: string): void

  • Parameters

    • string: string

    Returns void

print

  • print(...param: any[]): void

  • Parameters

    • Rest ...param: any[]

    Returns void

puts

  • puts(...param: any[]): void

  • Parameters

    • Rest ...param: any[]

    Returns void

"vm"

"vm":

Context

Context:

Script

Script:

runInNewContext

  • runInNewContext(sandbox?: Context): void

  • Parameters

    Returns void

runInThisContext

  • runInThisContext(): void

  • Returns void

createContext

  • Parameters

    Returns Context

createScript

  • createScript(code: string, filename?: string): Script

  • Parameters

    • code: string
    • Optional filename: string

    Returns Script

runInContext

  • runInContext(code: string, context: Context, filename?: string): void

  • Parameters

    • code: string
    • context: Context
    • Optional filename: string

    Returns void

runInNewContext

  • runInNewContext(code: string, sandbox?: Context, filename?: string): void

  • Parameters

    • code: string
    • Optional sandbox: Context
    • Optional filename: string

    Returns void

runInThisContext

  • runInThisContext(code: string, filename?: string): void

  • Parameters

    • code: string
    • Optional filename: string

    Returns void

"zlib"

"zlib":

Deflate

Deflate:

constructor

  • Parameters

    Returns Deflate

readable

readable: boolean

writable

writable: boolean

_flush

  • _flush(callback: Function): void

  • Parameters

    • callback: Function

    Returns void

_transform

  • _transform(chunk: Buffer, encoding: string, callback: Function): void
  • _transform(chunk: string, encoding: string, callback: Function): void

  • Parameters

    • chunk: Buffer
    • encoding: string
    • callback: Function

    Returns void

  • Parameters

    • chunk: string
    • encoding: string
    • callback: Function

    Returns void

addListener

  • addListener(event: string, listener: Function): EventEmitter

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

emit

  • emit(event: string, ...args: any[]): boolean

  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

end

  • end(): void
  • end(buffer: Buffer, cb?: Function): void
  • end(str: string, cb?: Function): void
  • end(str: string, encoding?: string, cb?: Function): void

  • Returns void

  • Parameters

    • buffer: Buffer
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns void

listeners

  • listeners(event: string): Function[]

  • Parameters

    • event: string

    Returns Function[]

on

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

once

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

pause

  • pause(): void

  • Returns void

pipe

  • pipe<T>(destination: T, options?: object): T

  • Type parameters

    Parameters

    • destination: T
    • Optional options: object
      • Optional end?: boolean

    Returns T

push

  • push(chunk: any, encoding?: string): boolean

  • Parameters

    • chunk: any
    • Optional encoding: string

    Returns boolean

read

  • read(size?: number): any

  • Parameters

    • Optional size: number

    Returns any

removeAllListeners

  • Parameters

    • Optional event: string

    Returns EventEmitter

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

resume

  • resume(): void

  • Returns void

setEncoding

  • setEncoding(encoding: string): void

  • Parameters

    • encoding: string

    Returns void

setMaxListeners

  • setMaxListeners(n: number): void

  • Parameters

    • n: number

    Returns void

unpipe

  • unpipe<T>(destination?: T): void

  • Type parameters

    Parameters

    • Optional destination: T

    Returns void

unshift

  • unshift(chunk: string): void
  • unshift(chunk: Buffer): void

  • Parameters

    • chunk: string

    Returns void

  • Parameters

    Returns void

wrap

  • Parameters

    Returns ReadableStream

write

  • write(buffer: Buffer, cb?: Function): boolean
  • write(str: string, cb?: Function): boolean
  • write(str: string, encoding?: string, cb?: Function): boolean

  • Parameters

    • buffer: Buffer
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns boolean

Static listenerCount

  • listenerCount(emitter: EventEmitter, event: string): number

  • Parameters

    Returns number

DeflateRaw

DeflateRaw:

constructor

  • Parameters

    Returns DeflateRaw

readable

readable: boolean

writable

writable: boolean

_flush

  • _flush(callback: Function): void

  • Parameters

    • callback: Function

    Returns void

_transform

  • _transform(chunk: Buffer, encoding: string, callback: Function): void
  • _transform(chunk: string, encoding: string, callback: Function): void

  • Parameters

    • chunk: Buffer
    • encoding: string
    • callback: Function

    Returns void

  • Parameters

    • chunk: string
    • encoding: string
    • callback: Function

    Returns void

addListener

  • addListener(event: string, listener: Function): EventEmitter

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

emit

  • emit(event: string, ...args: any[]): boolean

  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

end

  • end(): void
  • end(buffer: Buffer, cb?: Function): void
  • end(str: string, cb?: Function): void
  • end(str: string, encoding?: string, cb?: Function): void

  • Returns void

  • Parameters

    • buffer: Buffer
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns void

listeners

  • listeners(event: string): Function[]

  • Parameters

    • event: string

    Returns Function[]

on

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

once

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

pause

  • pause(): void

  • Returns void

pipe

  • pipe<T>(destination: T, options?: object): T

  • Type parameters

    Parameters

    • destination: T
    • Optional options: object
      • Optional end?: boolean

    Returns T

push

  • push(chunk: any, encoding?: string): boolean

  • Parameters

    • chunk: any
    • Optional encoding: string

    Returns boolean

read

  • read(size?: number): any

  • Parameters

    • Optional size: number

    Returns any

removeAllListeners

  • Parameters

    • Optional event: string

    Returns EventEmitter

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

resume

  • resume(): void

  • Returns void

setEncoding

  • setEncoding(encoding: string): void

  • Parameters

    • encoding: string

    Returns void

setMaxListeners

  • setMaxListeners(n: number): void

  • Parameters

    • n: number

    Returns void

unpipe

  • unpipe<T>(destination?: T): void

  • Type parameters

    Parameters

    • Optional destination: T

    Returns void

unshift

  • unshift(chunk: string): void
  • unshift(chunk: Buffer): void

  • Parameters

    • chunk: string

    Returns void

  • Parameters

    Returns void

wrap

  • Parameters

    Returns ReadableStream

write

  • write(buffer: Buffer, cb?: Function): boolean
  • write(str: string, cb?: Function): boolean
  • write(str: string, encoding?: string, cb?: Function): boolean

  • Parameters

    • buffer: Buffer
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns boolean

Static listenerCount

  • listenerCount(emitter: EventEmitter, event: string): number

  • Parameters

    Returns number

Gunzip

Gunzip:

constructor

  • Parameters

    Returns Gunzip

readable

readable: boolean

writable

writable: boolean

_flush

  • _flush(callback: Function): void

  • Parameters

    • callback: Function

    Returns void

_transform

  • _transform(chunk: Buffer, encoding: string, callback: Function): void
  • _transform(chunk: string, encoding: string, callback: Function): void

  • Parameters

    • chunk: Buffer
    • encoding: string
    • callback: Function

    Returns void

  • Parameters

    • chunk: string
    • encoding: string
    • callback: Function

    Returns void

addListener

  • addListener(event: string, listener: Function): EventEmitter

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

emit

  • emit(event: string, ...args: any[]): boolean

  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

end

  • end(): void
  • end(buffer: Buffer, cb?: Function): void
  • end(str: string, cb?: Function): void
  • end(str: string, encoding?: string, cb?: Function): void

  • Returns void

  • Parameters

    • buffer: Buffer
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns void

listeners

  • listeners(event: string): Function[]

  • Parameters

    • event: string

    Returns Function[]

on

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

once

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

pause

  • pause(): void

  • Returns void

pipe

  • pipe<T>(destination: T, options?: object): T

  • Type parameters

    Parameters

    • destination: T
    • Optional options: object
      • Optional end?: boolean

    Returns T

push

  • push(chunk: any, encoding?: string): boolean

  • Parameters

    • chunk: any
    • Optional encoding: string

    Returns boolean

read

  • read(size?: number): any

  • Parameters

    • Optional size: number

    Returns any

removeAllListeners

  • Parameters

    • Optional event: string

    Returns EventEmitter

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

resume

  • resume(): void

  • Returns void

setEncoding

  • setEncoding(encoding: string): void

  • Parameters

    • encoding: string

    Returns void

setMaxListeners

  • setMaxListeners(n: number): void

  • Parameters

    • n: number

    Returns void

unpipe

  • unpipe<T>(destination?: T): void

  • Type parameters

    Parameters

    • Optional destination: T

    Returns void

unshift

  • unshift(chunk: string): void
  • unshift(chunk: Buffer): void

  • Parameters

    • chunk: string

    Returns void

  • Parameters

    Returns void

wrap

  • Parameters

    Returns ReadableStream

write

  • write(buffer: Buffer, cb?: Function): boolean
  • write(str: string, cb?: Function): boolean
  • write(str: string, encoding?: string, cb?: Function): boolean

  • Parameters

    • buffer: Buffer
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns boolean

Static listenerCount

  • listenerCount(emitter: EventEmitter, event: string): number

  • Parameters

    Returns number

Gzip

Gzip:

constructor

  • Parameters

    Returns Gzip

readable

readable: boolean

writable

writable: boolean

_flush

  • _flush(callback: Function): void

  • Parameters

    • callback: Function

    Returns void

_transform

  • _transform(chunk: Buffer, encoding: string, callback: Function): void
  • _transform(chunk: string, encoding: string, callback: Function): void

  • Parameters

    • chunk: Buffer
    • encoding: string
    • callback: Function

    Returns void

  • Parameters

    • chunk: string
    • encoding: string
    • callback: Function

    Returns void

addListener

  • addListener(event: string, listener: Function): EventEmitter

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

emit

  • emit(event: string, ...args: any[]): boolean

  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

end

  • end(): void
  • end(buffer: Buffer, cb?: Function): void
  • end(str: string, cb?: Function): void
  • end(str: string, encoding?: string, cb?: Function): void

  • Returns void

  • Parameters

    • buffer: Buffer
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns void

listeners

  • listeners(event: string): Function[]

  • Parameters

    • event: string

    Returns Function[]

on

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

once

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

pause

  • pause(): void

  • Returns void

pipe

  • pipe<T>(destination: T, options?: object): T

  • Type parameters

    Parameters

    • destination: T
    • Optional options: object
      • Optional end?: boolean

    Returns T

push

  • push(chunk: any, encoding?: string): boolean

  • Parameters

    • chunk: any
    • Optional encoding: string

    Returns boolean

read

  • read(size?: number): any

  • Parameters

    • Optional size: number

    Returns any

removeAllListeners

  • Parameters

    • Optional event: string

    Returns EventEmitter

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

resume

  • resume(): void

  • Returns void

setEncoding

  • setEncoding(encoding: string): void

  • Parameters

    • encoding: string

    Returns void

setMaxListeners

  • setMaxListeners(n: number): void

  • Parameters

    • n: number

    Returns void

unpipe

  • unpipe<T>(destination?: T): void

  • Type parameters

    Parameters

    • Optional destination: T

    Returns void

unshift

  • unshift(chunk: string): void
  • unshift(chunk: Buffer): void

  • Parameters

    • chunk: string

    Returns void

  • Parameters

    Returns void

wrap

  • Parameters

    Returns ReadableStream

write

  • write(buffer: Buffer, cb?: Function): boolean
  • write(str: string, cb?: Function): boolean
  • write(str: string, encoding?: string, cb?: Function): boolean

  • Parameters

    • buffer: Buffer
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns boolean

Static listenerCount

  • listenerCount(emitter: EventEmitter, event: string): number

  • Parameters

    Returns number

Inflate

Inflate:

constructor

  • Parameters

    Returns Inflate

readable

readable: boolean

writable

writable: boolean

_flush

  • _flush(callback: Function): void

  • Parameters

    • callback: Function

    Returns void

_transform

  • _transform(chunk: Buffer, encoding: string, callback: Function): void
  • _transform(chunk: string, encoding: string, callback: Function): void

  • Parameters

    • chunk: Buffer
    • encoding: string
    • callback: Function

    Returns void

  • Parameters

    • chunk: string
    • encoding: string
    • callback: Function

    Returns void

addListener

  • addListener(event: string, listener: Function): EventEmitter

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

emit

  • emit(event: string, ...args: any[]): boolean

  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

end

  • end(): void
  • end(buffer: Buffer, cb?: Function): void
  • end(str: string, cb?: Function): void
  • end(str: string, encoding?: string, cb?: Function): void

  • Returns void

  • Parameters

    • buffer: Buffer
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns void

listeners

  • listeners(event: string): Function[]

  • Parameters

    • event: string

    Returns Function[]

on

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

once

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

pause

  • pause(): void

  • Returns void

pipe

  • pipe<T>(destination: T, options?: object): T

  • Type parameters

    Parameters

    • destination: T
    • Optional options: object
      • Optional end?: boolean

    Returns T

push

  • push(chunk: any, encoding?: string): boolean

  • Parameters

    • chunk: any
    • Optional encoding: string

    Returns boolean

read

  • read(size?: number): any

  • Parameters

    • Optional size: number

    Returns any

removeAllListeners

  • Parameters

    • Optional event: string

    Returns EventEmitter

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

resume

  • resume(): void

  • Returns void

setEncoding

  • setEncoding(encoding: string): void

  • Parameters

    • encoding: string

    Returns void

setMaxListeners

  • setMaxListeners(n: number): void

  • Parameters

    • n: number

    Returns void

unpipe

  • unpipe<T>(destination?: T): void

  • Type parameters

    Parameters

    • Optional destination: T

    Returns void

unshift

  • unshift(chunk: string): void
  • unshift(chunk: Buffer): void

  • Parameters

    • chunk: string

    Returns void

  • Parameters

    Returns void

wrap

  • Parameters

    Returns ReadableStream

write

  • write(buffer: Buffer, cb?: Function): boolean
  • write(str: string, cb?: Function): boolean
  • write(str: string, encoding?: string, cb?: Function): boolean

  • Parameters

    • buffer: Buffer
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns boolean

Static listenerCount

  • listenerCount(emitter: EventEmitter, event: string): number

  • Parameters

    Returns number

InflateRaw

InflateRaw:

constructor

  • Parameters

    Returns InflateRaw

readable

readable: boolean

writable

writable: boolean

_flush

  • _flush(callback: Function): void

  • Parameters

    • callback: Function

    Returns void

_transform

  • _transform(chunk: Buffer, encoding: string, callback: Function): void
  • _transform(chunk: string, encoding: string, callback: Function): void

  • Parameters

    • chunk: Buffer
    • encoding: string
    • callback: Function

    Returns void

  • Parameters

    • chunk: string
    • encoding: string
    • callback: Function

    Returns void

addListener

  • addListener(event: string, listener: Function): EventEmitter

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

emit

  • emit(event: string, ...args: any[]): boolean

  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

end

  • end(): void
  • end(buffer: Buffer, cb?: Function): void
  • end(str: string, cb?: Function): void
  • end(str: string, encoding?: string, cb?: Function): void

  • Returns void

  • Parameters

    • buffer: Buffer
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns void

listeners

  • listeners(event: string): Function[]

  • Parameters

    • event: string

    Returns Function[]

on

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

once

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

pause

  • pause(): void

  • Returns void

pipe

  • pipe<T>(destination: T, options?: object): T

  • Type parameters

    Parameters

    • destination: T
    • Optional options: object
      • Optional end?: boolean

    Returns T

push

  • push(chunk: any, encoding?: string): boolean

  • Parameters

    • chunk: any
    • Optional encoding: string

    Returns boolean

read

  • read(size?: number): any

  • Parameters

    • Optional size: number

    Returns any

removeAllListeners

  • Parameters

    • Optional event: string

    Returns EventEmitter

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

resume

  • resume(): void

  • Returns void

setEncoding

  • setEncoding(encoding: string): void

  • Parameters

    • encoding: string

    Returns void

setMaxListeners

  • setMaxListeners(n: number): void

  • Parameters

    • n: number

    Returns void

unpipe

  • unpipe<T>(destination?: T): void

  • Type parameters

    Parameters

    • Optional destination: T

    Returns void

unshift

  • unshift(chunk: string): void
  • unshift(chunk: Buffer): void

  • Parameters

    • chunk: string

    Returns void

  • Parameters

    Returns void

wrap

  • Parameters

    Returns ReadableStream

write

  • write(buffer: Buffer, cb?: Function): boolean
  • write(str: string, cb?: Function): boolean
  • write(str: string, encoding?: string, cb?: Function): boolean

  • Parameters

    • buffer: Buffer
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns boolean

Static listenerCount

  • listenerCount(emitter: EventEmitter, event: string): number

  • Parameters

    Returns number

Unzip

Unzip:

constructor

  • Parameters

    Returns Unzip

readable

readable: boolean

writable

writable: boolean

_flush

  • _flush(callback: Function): void

  • Parameters

    • callback: Function

    Returns void

_transform

  • _transform(chunk: Buffer, encoding: string, callback: Function): void
  • _transform(chunk: string, encoding: string, callback: Function): void

  • Parameters

    • chunk: Buffer
    • encoding: string
    • callback: Function

    Returns void

  • Parameters

    • chunk: string
    • encoding: string
    • callback: Function

    Returns void

addListener

  • addListener(event: string, listener: Function): EventEmitter

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

emit

  • emit(event: string, ...args: any[]): boolean

  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

end

  • end(): void
  • end(buffer: Buffer, cb?: Function): void
  • end(str: string, cb?: Function): void
  • end(str: string, encoding?: string, cb?: Function): void

  • Returns void

  • Parameters

    • buffer: Buffer
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns void

listeners

  • listeners(event: string): Function[]

  • Parameters

    • event: string

    Returns Function[]

on

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

once

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

pause

  • pause(): void

  • Returns void

pipe

  • pipe<T>(destination: T, options?: object): T

  • Type parameters

    Parameters

    • destination: T
    • Optional options: object
      • Optional end?: boolean

    Returns T

push

  • push(chunk: any, encoding?: string): boolean

  • Parameters

    • chunk: any
    • Optional encoding: string

    Returns boolean

read

  • read(size?: number): any

  • Parameters

    • Optional size: number

    Returns any

removeAllListeners

  • Parameters

    • Optional event: string

    Returns EventEmitter

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

resume

  • resume(): void

  • Returns void

setEncoding

  • setEncoding(encoding: string): void

  • Parameters

    • encoding: string

    Returns void

setMaxListeners

  • setMaxListeners(n: number): void

  • Parameters

    • n: number

    Returns void

unpipe

  • unpipe<T>(destination?: T): void

  • Type parameters

    Parameters

    • Optional destination: T

    Returns void

unshift

  • unshift(chunk: string): void
  • unshift(chunk: Buffer): void

  • Parameters

    • chunk: string

    Returns void

  • Parameters

    Returns void

wrap

  • Parameters

    Returns ReadableStream

write

  • write(buffer: Buffer, cb?: Function): boolean
  • write(str: string, cb?: Function): boolean
  • write(str: string, encoding?: string, cb?: Function): boolean

  • Parameters

    • buffer: Buffer
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns boolean

Static listenerCount

  • listenerCount(emitter: EventEmitter, event: string): number

  • Parameters

    Returns number

ZlibOptions

ZlibOptions:

Optional chunkSize

chunkSize: number

Optional dictionary

dictionary: any

Optional level

level: number

Optional memLevel

memLevel: number

Optional strategy

strategy: number

Optional windowBits

windowBits: number

Z_ASCII

Z_ASCII: number

Z_BEST_COMPRESSION

Z_BEST_COMPRESSION: number

Z_BEST_SPEED

Z_BEST_SPEED: number

Z_BINARY

Z_BINARY: number

Z_BLOCK

Z_BLOCK: number

Z_BUF_ERROR

Z_BUF_ERROR: number

Z_DATA_ERROR

Z_DATA_ERROR: number

Z_DEFAULT_COMPRESSION

Z_DEFAULT_COMPRESSION: number

Z_DEFAULT_STRATEGY

Z_DEFAULT_STRATEGY: number

Z_DEFLATED

Z_DEFLATED: number

Z_ERRNO

Z_ERRNO: number

Z_FILTERED

Z_FILTERED: number

Z_FINISH

Z_FINISH: number

Z_FIXED

Z_FIXED: number

Z_FULL_FLUSH

Z_FULL_FLUSH: number

Z_HUFFMAN_ONLY

Z_HUFFMAN_ONLY: number

Z_MEM_ERROR

Z_MEM_ERROR: number

Z_NEED_DICT

Z_NEED_DICT: number

Z_NO_COMPRESSION

Z_NO_COMPRESSION: number

Z_NO_FLUSH

Z_NO_FLUSH: number

Z_NULL

Z_NULL: number

Z_OK

Z_OK: number

Z_PARTIAL_FLUSH

Z_PARTIAL_FLUSH: number

Z_RLE

Z_RLE: number

Z_STREAM_END

Z_STREAM_END: number

Z_STREAM_ERROR

Z_STREAM_ERROR: number

Z_SYNC_FLUSH

Z_SYNC_FLUSH: number

Z_TEXT

Z_TEXT: number

Z_TREES

Z_TREES: number

Z_UNKNOWN

Z_UNKNOWN: number

Z_VERSION_ERROR

Z_VERSION_ERROR: number

createDeflate

  • Parameters

    Returns Deflate

createDeflateRaw

  • Parameters

    Returns DeflateRaw

createGunzip

  • Parameters

    Returns Gunzip

createGzip

  • Parameters

    Returns Gzip

createInflate

  • Parameters

    Returns Inflate

createInflateRaw

  • Parameters

    Returns InflateRaw

createUnzip

  • Parameters

    Returns Unzip

deflate

  • deflate(buf: Buffer, callback: function): void

  • Parameters

    • buf: Buffer
    • callback: function
        • (error: Error, result: any): void

        • Parameters

          • error: Error
          • result: any

          Returns void

    Returns void

deflateRaw

  • deflateRaw(buf: Buffer, callback: function): void

  • Parameters

    • buf: Buffer
    • callback: function
        • (error: Error, result: any): void

        • Parameters

          • error: Error
          • result: any

          Returns void

    Returns void

gunzip

  • gunzip(buf: Buffer, callback: function): void

  • Parameters

    • buf: Buffer
    • callback: function
        • (error: Error, result: any): void

        • Parameters

          • error: Error
          • result: any

          Returns void

    Returns void

gzip

  • gzip(buf: Buffer, callback: function): void

  • Parameters

    • buf: Buffer
    • callback: function
        • (error: Error, result: any): void

        • Parameters

          • error: Error
          • result: any

          Returns void

    Returns void

inflate

  • inflate(buf: Buffer, callback: function): void

  • Parameters

    • buf: Buffer
    • callback: function
        • (error: Error, result: any): void

        • Parameters

          • error: Error
          • result: any

          Returns void

    Returns void

inflateRaw

  • inflateRaw(buf: Buffer, callback: function): void

  • Parameters

    • buf: Buffer
    • callback: function
        • (error: Error, result: any): void

        • Parameters

          • error: Error
          • result: any

          Returns void

    Returns void

unzip

  • unzip(buf: Buffer, callback: function): void

  • Parameters

    • buf: Buffer
    • callback: function
        • (error: Error, result: any): void

        • Parameters

          • error: Error
          • result: any

          Returns void

    Returns void

NodeJS

NodeJS: 
                                          *
          GLOBAL INTERFACES               *
                                          *

ErrnoException

ErrnoException:

Error

Error: ErrorConstructor

Optional code

code: string

Optional errno

errno: any

message

message: string

name

name: string

Optional path

path: string

Optional syscall

syscall: string

EventEmitter

EventEmitter:

addListener

  • addListener(event: string, listener: Function): EventEmitter

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

emit

  • emit(event: string, ...args: any[]): boolean

  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

listeners

  • listeners(event: string): Function[]

  • Parameters

    • event: string

    Returns Function[]

on

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

once

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

removeAllListeners

  • Parameters

    • Optional event: string

    Returns EventEmitter

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

setMaxListeners

  • setMaxListeners(n: number): void

  • Parameters

    • n: number

    Returns void

Process

Process:

arch

arch: string

argv

argv: string[]

config

config: object

Type declaration

  • target_defaults: object
    • cflags: any[]
    • default_configuration: string
    • defines: string[]
    • include_dirs: string[]
    • libraries: string[]
  • variables: object
    • clang: number
    • host_arch: string
    • node_install_npm: boolean
    • node_install_waf: boolean
    • node_prefix: string
    • node_shared_openssl: boolean
    • node_shared_v8: boolean
    • node_shared_zlib: boolean
    • node_use_dtrace: boolean
    • node_use_etw: boolean
    • node_use_openssl: boolean
    • target_arch: string
    • v8_no_strict_aliasing: number
    • v8_use_snapshot: boolean
    • visibility: string

env

env: any

execPath

execPath: string

pid

pid: number

platform

platform: string

stderr

stderr: WritableStream

stdin

stdin: ReadableStream

stdout

stdout: WritableStream

title

title: string

version

version: string

versions

versions: object

Type declaration

  • ares: string
  • http_parser: string
  • node: string
  • openssl: string
  • uv: string
  • v8: string
  • zlib: string

abort

  • abort(): void

  • Returns void

addListener

  • addListener(event: string, listener: Function): EventEmitter

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

chdir

  • chdir(directory: string): void

  • Parameters

    • directory: string

    Returns void

cwd

  • cwd(): string

  • Returns string

emit

  • emit(event: string, ...args: any[]): boolean

  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

exit

  • exit(code?: number): void

  • Parameters

    • Optional code: number

    Returns void

getgid

  • getgid(): number

  • Returns number

getuid

  • getuid(): number

  • Returns number

hrtime

  • hrtime(time?: number[]): number[]

  • Parameters

    • Optional time: number[]

    Returns number[]

kill

  • kill(pid: number, signal?: string): void

  • Parameters

    • pid: number
    • Optional signal: string

    Returns void

listeners

  • listeners(event: string): Function[]

  • Parameters

    • event: string

    Returns Function[]

memoryUsage

  • memoryUsage(): object

  • Returns object

    • heapTotal: number
    • heapUsed: number
    • rss: number

nextTick

  • nextTick(callback: Function): void

  • Parameters

    • callback: Function

    Returns void

on

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

once

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

removeAllListeners

  • Parameters

    • Optional event: string

    Returns EventEmitter

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

Optional send

  • send(message: any, sendHandle?: any): void

  • Parameters

    • message: any
    • Optional sendHandle: any

    Returns void

setMaxListeners

  • setMaxListeners(n: number): void

  • Parameters

    • n: number

    Returns void

setgid

  • setgid(id: number): void
  • setgid(id: string): void

  • Parameters

    • id: number

    Returns void

  • Parameters

    • id: string

    Returns void

setuid

  • setuid(id: number): void
  • setuid(id: string): void

  • Parameters

    • id: number

    Returns void

  • Parameters

    • id: string

    Returns void

umask

  • umask(mask?: number): number

  • Parameters

    • Optional mask: number

    Returns number

uptime

  • uptime(): number

  • Returns number

ReadWriteStream

ReadWriteStream:

readable

readable: boolean

writable

writable: boolean

addListener

  • addListener(event: string, listener: Function): EventEmitter

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

emit

  • emit(event: string, ...args: any[]): boolean

  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

end

  • end(): void
  • end(buffer: Buffer, cb?: Function): void
  • end(str: string, cb?: Function): void
  • end(str: string, encoding?: string, cb?: Function): void

  • Returns void

  • Parameters

    • buffer: Buffer
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns void

listeners

  • listeners(event: string): Function[]

  • Parameters

    • event: string

    Returns Function[]

on

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

once

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

pause

  • pause(): void

  • Returns void

pipe

  • pipe<T>(destination: T, options?: object): T

  • Type parameters

    Parameters

    • destination: T
    • Optional options: object
      • Optional end?: boolean

    Returns T

read

  • read(size?: number): any

  • Parameters

    • Optional size: number

    Returns any

removeAllListeners

  • Parameters

    • Optional event: string

    Returns EventEmitter

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

resume

  • resume(): void

  • Returns void

setEncoding

  • setEncoding(encoding: string): void

  • Parameters

    • encoding: string

    Returns void

setMaxListeners

  • setMaxListeners(n: number): void

  • Parameters

    • n: number

    Returns void

unpipe

  • unpipe<T>(destination?: T): void

  • Type parameters

    Parameters

    • Optional destination: T

    Returns void

unshift

  • unshift(chunk: string): void
  • unshift(chunk: Buffer): void

  • Parameters

    • chunk: string

    Returns void

  • Parameters

    Returns void

wrap

  • Parameters

    Returns ReadableStream

write

  • write(buffer: Buffer, cb?: Function): boolean
  • write(str: string, cb?: Function): boolean
  • write(str: string, encoding?: string, cb?: Function): boolean

  • Parameters

    • buffer: Buffer
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns boolean

ReadableStream

ReadableStream:

readable

readable: boolean

addListener

  • addListener(event: string, listener: Function): EventEmitter

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

emit

  • emit(event: string, ...args: any[]): boolean

  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

listeners

  • listeners(event: string): Function[]

  • Parameters

    • event: string

    Returns Function[]

on

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

once

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

pause

  • pause(): void

  • Returns void

pipe

  • pipe<T>(destination: T, options?: object): T

  • Type parameters

    Parameters

    • destination: T
    • Optional options: object
      • Optional end?: boolean

    Returns T

read

  • read(size?: number): any

  • Parameters

    • Optional size: number

    Returns any

removeAllListeners

  • Parameters

    • Optional event: string

    Returns EventEmitter

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

resume

  • resume(): void

  • Returns void

setEncoding

  • setEncoding(encoding: string): void

  • Parameters

    • encoding: string

    Returns void

setMaxListeners

  • setMaxListeners(n: number): void

  • Parameters

    • n: number

    Returns void

unpipe

  • unpipe<T>(destination?: T): void

  • Type parameters

    Parameters

    • Optional destination: T

    Returns void

unshift

  • unshift(chunk: string): void
  • unshift(chunk: Buffer): void

  • Parameters

    • chunk: string

    Returns void

  • Parameters

    Returns void

wrap

Timer

Timer:

ref

  • ref(): void

  • Returns void

unref

  • unref(): void

  • Returns void

WritableStream

WritableStream:

writable

writable: boolean

addListener

  • addListener(event: string, listener: Function): EventEmitter

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

emit

  • emit(event: string, ...args: any[]): boolean

  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

end

  • end(): void
  • end(buffer: Buffer, cb?: Function): void
  • end(str: string, cb?: Function): void
  • end(str: string, encoding?: string, cb?: Function): void

  • Returns void

  • Parameters

    • buffer: Buffer
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns void

listeners

  • listeners(event: string): Function[]

  • Parameters

    • event: string

    Returns Function[]

on

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

once

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

removeAllListeners

  • Parameters

    • Optional event: string

    Returns EventEmitter

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

setMaxListeners

  • setMaxListeners(n: number): void

  • Parameters

    • n: number

    Returns void

write

  • write(buffer: Buffer, cb?: Function): boolean
  • write(str: string, cb?: Function): boolean
  • write(str: string, encoding?: string, cb?: Function): boolean

  • Parameters

    • buffer: Buffer
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns boolean

Buffer

Buffer:

length

length: number

copy

  • copy(targetBuffer: Buffer, targetStart?: number, sourceStart?: number, sourceEnd?: number): number

  • Parameters

    • targetBuffer: Buffer
    • Optional targetStart: number
    • Optional sourceStart: number
    • Optional sourceEnd: number

    Returns number

fill

  • fill(value: any, offset?: number, end?: number): void

  • Parameters

    • value: any
    • Optional offset: number
    • Optional end: number

    Returns void

readDoubleBE

  • readDoubleBE(offset: number, noAssert?: boolean): number

  • Parameters

    • offset: number
    • Optional noAssert: boolean

    Returns number

readDoubleLE

  • readDoubleLE(offset: number, noAssert?: boolean): number

  • Parameters

    • offset: number
    • Optional noAssert: boolean

    Returns number

readFloatBE

  • readFloatBE(offset: number, noAssert?: boolean): number

  • Parameters

    • offset: number
    • Optional noAssert: boolean

    Returns number

readFloatLE

  • readFloatLE(offset: number, noAssert?: boolean): number

  • Parameters

    • offset: number
    • Optional noAssert: boolean

    Returns number

readInt16BE

  • readInt16BE(offset: number, noAssert?: boolean): number

  • Parameters

    • offset: number
    • Optional noAssert: boolean

    Returns number

readInt16LE

  • readInt16LE(offset: number, noAssert?: boolean): number

  • Parameters

    • offset: number
    • Optional noAssert: boolean

    Returns number

readInt32BE

  • readInt32BE(offset: number, noAssert?: boolean): number

  • Parameters

    • offset: number
    • Optional noAssert: boolean

    Returns number

readInt32LE

  • readInt32LE(offset: number, noAssert?: boolean): number

  • Parameters

    • offset: number
    • Optional noAssert: boolean

    Returns number

readInt8

  • readInt8(offset: number, noAssert?: boolean): number

  • Parameters

    • offset: number
    • Optional noAssert: boolean

    Returns number

readUInt16BE

  • readUInt16BE(offset: number, noAssert?: boolean): number

  • Parameters

    • offset: number
    • Optional noAssert: boolean

    Returns number

readUInt16LE

  • readUInt16LE(offset: number, noAssert?: boolean): number

  • Parameters

    • offset: number
    • Optional noAssert: boolean

    Returns number

readUInt32BE

  • readUInt32BE(offset: number, noAssert?: boolean): number

  • Parameters

    • offset: number
    • Optional noAssert: boolean

    Returns number

readUInt32LE

  • readUInt32LE(offset: number, noAssert?: boolean): number

  • Parameters

    • offset: number
    • Optional noAssert: boolean

    Returns number

readUInt8

  • readUInt8(offset: number, noAsset?: boolean): number

  • Parameters

    • offset: number
    • Optional noAsset: boolean

    Returns number

slice

  • slice(start?: number, end?: number): Buffer

  • Parameters

    • Optional start: number
    • Optional end: number

    Returns Buffer

toJSON

  • toJSON(): any

  • Returns any

toString

  • toString(encoding?: string, start?: number, end?: number): string

  • Parameters

    • Optional encoding: string
    • Optional start: number
    • Optional end: number

    Returns string

write

  • write(string: string, offset?: number, length?: number, encoding?: string): number

  • Parameters

    • string: string
    • Optional offset: number
    • Optional length: number
    • Optional encoding: string

    Returns number

writeDoubleBE

  • writeDoubleBE(value: number, offset: number, noAssert?: boolean): void

  • Parameters

    • value: number
    • offset: number
    • Optional noAssert: boolean

    Returns void

writeDoubleLE

  • writeDoubleLE(value: number, offset: number, noAssert?: boolean): void

  • Parameters

    • value: number
    • offset: number
    • Optional noAssert: boolean

    Returns void

writeFloatBE

  • writeFloatBE(value: number, offset: number, noAssert?: boolean): void

  • Parameters

    • value: number
    • offset: number
    • Optional noAssert: boolean

    Returns void

writeFloatLE

  • writeFloatLE(value: number, offset: number, noAssert?: boolean): void

  • Parameters

    • value: number
    • offset: number
    • Optional noAssert: boolean

    Returns void

writeInt16BE

  • writeInt16BE(value: number, offset: number, noAssert?: boolean): void

  • Parameters

    • value: number
    • offset: number
    • Optional noAssert: boolean

    Returns void

writeInt16LE

  • writeInt16LE(value: number, offset: number, noAssert?: boolean): void

  • Parameters

    • value: number
    • offset: number
    • Optional noAssert: boolean

    Returns void

writeInt32BE

  • writeInt32BE(value: number, offset: number, noAssert?: boolean): void

  • Parameters

    • value: number
    • offset: number
    • Optional noAssert: boolean

    Returns void

writeInt32LE

  • writeInt32LE(value: number, offset: number, noAssert?: boolean): void

  • Parameters

    • value: number
    • offset: number
    • Optional noAssert: boolean

    Returns void

writeInt8

  • writeInt8(value: number, offset: number, noAssert?: boolean): void

  • Parameters

    • value: number
    • offset: number
    • Optional noAssert: boolean

    Returns void

writeUInt16BE

  • writeUInt16BE(value: number, offset: number, noAssert?: boolean): void

  • Parameters

    • value: number
    • offset: number
    • Optional noAssert: boolean

    Returns void

writeUInt16LE

  • writeUInt16LE(value: number, offset: number, noAssert?: boolean): void

  • Parameters

    • value: number
    • offset: number
    • Optional noAssert: boolean

    Returns void

writeUInt32BE

  • writeUInt32BE(value: number, offset: number, noAssert?: boolean): void

  • Parameters

    • value: number
    • offset: number
    • Optional noAssert: boolean

    Returns void

writeUInt32LE

  • writeUInt32LE(value: number, offset: number, noAssert?: boolean): void

  • Parameters

    • value: number
    • offset: number
    • Optional noAssert: boolean

    Returns void

writeUInt8

  • writeUInt8(value: number, offset: number, noAssert?: boolean): void

  • Parameters

    • value: number
    • offset: number
    • Optional noAssert: boolean

    Returns void

NodeBuffer

NodeBuffer:
deprecated

length

length: number

copy

  • copy(targetBuffer: Buffer, targetStart?: number, sourceStart?: number, sourceEnd?: number): number

  • Parameters

    • targetBuffer: Buffer
    • Optional targetStart: number
    • Optional sourceStart: number
    • Optional sourceEnd: number

    Returns number

fill

  • fill(value: any, offset?: number, end?: number): void

  • Parameters

    • value: any
    • Optional offset: number
    • Optional end: number

    Returns void

readDoubleBE

  • readDoubleBE(offset: number, noAssert?: boolean): number

  • Parameters

    • offset: number
    • Optional noAssert: boolean

    Returns number

readDoubleLE

  • readDoubleLE(offset: number, noAssert?: boolean): number

  • Parameters

    • offset: number
    • Optional noAssert: boolean

    Returns number

readFloatBE

  • readFloatBE(offset: number, noAssert?: boolean): number

  • Parameters

    • offset: number
    • Optional noAssert: boolean

    Returns number

readFloatLE

  • readFloatLE(offset: number, noAssert?: boolean): number

  • Parameters

    • offset: number
    • Optional noAssert: boolean

    Returns number

readInt16BE

  • readInt16BE(offset: number, noAssert?: boolean): number

  • Parameters

    • offset: number
    • Optional noAssert: boolean

    Returns number

readInt16LE

  • readInt16LE(offset: number, noAssert?: boolean): number

  • Parameters

    • offset: number
    • Optional noAssert: boolean

    Returns number

readInt32BE

  • readInt32BE(offset: number, noAssert?: boolean): number

  • Parameters

    • offset: number
    • Optional noAssert: boolean

    Returns number

readInt32LE

  • readInt32LE(offset: number, noAssert?: boolean): number

  • Parameters

    • offset: number
    • Optional noAssert: boolean

    Returns number

readInt8

  • readInt8(offset: number, noAssert?: boolean): number

  • Parameters

    • offset: number
    • Optional noAssert: boolean

    Returns number

readUInt16BE

  • readUInt16BE(offset: number, noAssert?: boolean): number

  • Parameters

    • offset: number
    • Optional noAssert: boolean

    Returns number

readUInt16LE

  • readUInt16LE(offset: number, noAssert?: boolean): number

  • Parameters

    • offset: number
    • Optional noAssert: boolean

    Returns number

readUInt32BE

  • readUInt32BE(offset: number, noAssert?: boolean): number

  • Parameters

    • offset: number
    • Optional noAssert: boolean

    Returns number

readUInt32LE

  • readUInt32LE(offset: number, noAssert?: boolean): number

  • Parameters

    • offset: number
    • Optional noAssert: boolean

    Returns number

readUInt8

  • readUInt8(offset: number, noAsset?: boolean): number

  • Parameters

    • offset: number
    • Optional noAsset: boolean

    Returns number

slice

  • slice(start?: number, end?: number): Buffer

  • Parameters

    • Optional start: number
    • Optional end: number

    Returns Buffer

toJSON

  • toJSON(): any

  • Returns any

toString

  • toString(encoding?: string, start?: number, end?: number): string

  • Parameters

    • Optional encoding: string
    • Optional start: number
    • Optional end: number

    Returns string

write

  • write(string: string, offset?: number, length?: number, encoding?: string): number

  • Parameters

    • string: string
    • Optional offset: number
    • Optional length: number
    • Optional encoding: string

    Returns number

writeDoubleBE

  • writeDoubleBE(value: number, offset: number, noAssert?: boolean): void

  • Parameters

    • value: number
    • offset: number
    • Optional noAssert: boolean

    Returns void

writeDoubleLE

  • writeDoubleLE(value: number, offset: number, noAssert?: boolean): void

  • Parameters

    • value: number
    • offset: number
    • Optional noAssert: boolean

    Returns void

writeFloatBE

  • writeFloatBE(value: number, offset: number, noAssert?: boolean): void

  • Parameters

    • value: number
    • offset: number
    • Optional noAssert: boolean

    Returns void

writeFloatLE

  • writeFloatLE(value: number, offset: number, noAssert?: boolean): void

  • Parameters

    • value: number
    • offset: number
    • Optional noAssert: boolean

    Returns void

writeInt16BE

  • writeInt16BE(value: number, offset: number, noAssert?: boolean): void

  • Parameters

    • value: number
    • offset: number
    • Optional noAssert: boolean

    Returns void

writeInt16LE

  • writeInt16LE(value: number, offset: number, noAssert?: boolean): void

  • Parameters

    • value: number
    • offset: number
    • Optional noAssert: boolean

    Returns void

writeInt32BE

  • writeInt32BE(value: number, offset: number, noAssert?: boolean): void

  • Parameters

    • value: number
    • offset: number
    • Optional noAssert: boolean

    Returns void

writeInt32LE

  • writeInt32LE(value: number, offset: number, noAssert?: boolean): void

  • Parameters

    • value: number
    • offset: number
    • Optional noAssert: boolean

    Returns void

writeInt8

  • writeInt8(value: number, offset: number, noAssert?: boolean): void

  • Parameters

    • value: number
    • offset: number
    • Optional noAssert: boolean

    Returns void

writeUInt16BE

  • writeUInt16BE(value: number, offset: number, noAssert?: boolean): void

  • Parameters

    • value: number
    • offset: number
    • Optional noAssert: boolean

    Returns void

writeUInt16LE

  • writeUInt16LE(value: number, offset: number, noAssert?: boolean): void

  • Parameters

    • value: number
    • offset: number
    • Optional noAssert: boolean

    Returns void

writeUInt32BE

  • writeUInt32BE(value: number, offset: number, noAssert?: boolean): void

  • Parameters

    • value: number
    • offset: number
    • Optional noAssert: boolean

    Returns void

writeUInt32LE

  • writeUInt32LE(value: number, offset: number, noAssert?: boolean): void

  • Parameters

    • value: number
    • offset: number
    • Optional noAssert: boolean

    Returns void

writeUInt8

  • writeUInt8(value: number, offset: number, noAssert?: boolean): void

  • Parameters

    • value: number
    • offset: number
    • Optional noAssert: boolean

    Returns void

SlowBuffer

SlowBuffer: object

Type declaration

  • constructor: function
    • new __type(str: string, encoding?: string): __type
    • new __type(size: number): __type
    • new __type(size: Uint8Array): __type
    • new __type(array: any[]): __type

    • Parameters

      • str: string
      • Optional encoding: string

      Returns __type

    • Parameters

      • size: number

      Returns __type

    • Parameters

      • size: Uint8Array

      Returns __type

    • Parameters

      • array: any[]

      Returns __type

  • prototype: Buffer
  • byteLength: function
    • byteLength(string: string, encoding?: string): number

    • Parameters

      • string: string
      • Optional encoding: string

      Returns number

  • concat: function

    • Parameters

      • list: Buffer[]
      • Optional totalLength: number

      Returns Buffer

  • isBuffer: function
    • isBuffer(obj: any): boolean

    • Parameters

      • obj: any

      Returns boolean

___dirname

___dirname: string

___filename

___filename: string

exports

exports: any

global

global: any

module

module: object

Type declaration

  • children: any[]
  • exports: any
  • filename: string
  • id: string
  • loaded: boolean
  • parent: any
  • require: function
    • require(id: string): any

    • Parameters

      • id: string

      Returns any

process

process: Process
                                          *
              GLOBAL                      *
                                          *

require

require: object

Type declaration

    • (id: string): any

    • Parameters

      • id: string

      Returns any

  • cache: any
  • extensions: any
  • main: any
  • resolve: function
    • resolve(id: string): string

    • Parameters

      • id: string

      Returns string

clearImmediate

  • clearImmediate(immediateId: any): void

  • Parameters

    • immediateId: any

    Returns void

clearInterval

  • clearInterval(intervalId: Timer): void

  • Parameters

    Returns void

clearTimeout

  • clearTimeout(timeoutId: Timer): void

  • Parameters

    Returns void

setImmediate

  • setImmediate(callback: function, ...args: any[]): any

  • Parameters

    • callback: function
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    • Rest ...args: any[]

    Returns any

setInterval

  • setInterval(callback: function, ms: number, ...args: any[]): Timer

  • Parameters

    • callback: function
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    • ms: number
    • Rest ...args: any[]

    Returns Timer

setTimeout

  • setTimeout(callback: function, ms: number, ...args: any[]): Timer

  • Parameters

    • callback: function
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    • ms: number
    • Rest ...args: any[]

    Returns Timer

"typings/main/ambient/pluralize/index.d"

"typings/main/ambient/pluralize/index.d":

"pluralize"

"pluralize":

plural

  • plural(value: string): string

  • Parameters

    • value: string

    Returns string

singular

  • singular(value: string): string

  • Parameters

    • value: string

    Returns string

"typings/main/ambient/raml/index.d"

"typings/main/ambient/raml/index.d":

"raml-parser"

"raml-parser":

FileReader

FileReader:

constructor

  • Parameters

    • cb: function

        • Parameters

          • path: string

          Returns Promise<string>

    Returns FileReader

LoadOptions

LoadOptions:

reader

reader: FileReader

load

  • Parameters

    • str: string
    • Optional path: string
    • Optional options: LoadOptions

    Returns Promise<Api>

loadFile

  • Parameters

    Returns Promise<Api>

Raml08Parser

Raml08Parser:

Api

Api:

Optional baseUri

baseUri: string
see

http://raml.org/spec.html#base-uri-and-baseuriparameters

Optional baseUriParameters

baseUriParameters: NamedParameterMap
see

http://raml.org/spec.html#base-uri-and-baseuriparameters

Optional documentation

documentation: DocumentationItem[]

(Optional) The API definition can include a variety of documents that serve as a user guides and reference documentation for the API. Such documents can clarify how the API works or provide business context.

see

http://raml.org/spec.html#user-documentation

Optional mediaType

mediaType: MediaType

(Optional) The media types returned by API responses, and expected from API requests that accept a body, MAY be defaulted by specifying the mediaType property. This property is specified at the root level of the API definition. The property's value MAY be a single string with a valid media type

see

http://raml.org/spec.html#default-media-type

Optional protocols

protocols: Protocol[]

(Optional) A RESTful API can be reached HTTP, HTTPS, or both. The protocols property MAY be used to specify the protocols that an API supports. If the protocols property is not specified, the protocol specified at the baseUri property is used. The protocols property MUST be an array of strings, of values "HTTP" and/or "HTTPS".

see

http://raml.org/spec.html#protocols

Optional resourceTypes

resourceTypes: object[]
see

http://raml.org/spec.html#resource-types-and-traits

Type declaration

Optional resources

resources: Resource[]
see

http://raml.org/spec.html#resources-and-nested-resources

Optional schemas

schemas: GlobalSchemas

(Optional) To better achieve consistency and simplicity, the API definition SHOULD include an OPTIONAL schemas property in the root section. The schemas property specifies collections of schemas that could be used anywhere in the API definition. The value of the schemas property is an array of maps; in each map, the keys are the schema name, and the values are schema definitions.

see

http://raml.org/spec.html#schemas

Optional securedBy

securedBy: SecuredBy

Optional securitySchemes

securitySchemes: object[]

Type declaration

Optional title

title: string

(Required) The title property is a short plain text description of the RESTful API. The title property's value SHOULD be suitable for use as a title for the contained user documentation.

see

http://raml.org/spec.html#api-title

Optional traits

traits: object[]

Type declaration

  • [traitName: string]: Trait

Optional uriParameters

uriParameters: NamedParameterMap

(Optional) In addition to the reserved URI parameters described in the baseUri property section, a Level 1 Template URI can feature custom URI parameters, which are useful in a variety of scenarios. For example, let's look at the following API provider that parametrizes the base URI with customer information such as the company name.

see

http://raml.org/spec.html#uri-parameters

Optional version

version: string

(Optional) If the RAML API definition is targeted to a specific API version, the API definition MUST contain a version property. The version property is OPTIONAL and should not be used if:

The API itself is not versioned. The API definition does not change between versions. The API architect can decide whether a change to user documentation elements, but no change to the API's resources, constitutes a version change. The API architect MAY use any versioning scheme so long as version numbers retain the same format. For example, "v3", "v3.0", and "V3" are all allowed, but are not considered to be equal.

BasicNamedParameter

BasicNamedParameter:
see

http://raml.org/spec.html#named-parameters

Optional default

default: any

(Optional) The default attribute specifies the default value to use for the property if the property is omitted or its value is not specified. This SHOULD NOT be interpreted as a requirement for the client to send the default attribute's value if there is no other value to send. Instead, the default attribute's value is the value the server uses if the client does not send a value.

Optional description

description: MarkdownString

(Optional) The description attribute describes the intended use or meaning of the parameter. This value MAY be formatted using Markdown [MARKDOWN].

see

http://raml.org/spec.html#description

Optional displayName

displayName: string

(Optional) The displayName attribute specifies the parameter's display name. It is a friendly name used only for display or documentation purposes. If displayName is not specified, it defaults to the property's key (the name of the property itself).

see

http://raml.org/spec.html#displayname

Optional enum

enum: any[]

(Optional, applicable only for parameters of type string) The enum attribute provides an enumeration of the parameter's valid values. This MUST be an array.

If the enum attribute is defined, API clients and servers MUST verify that a parameter's value matches a value in the enum array.

If there is no matching value, the clients and servers MUST treat this as an error.

see

http://raml.org/spec.html#enum

Optional example

example: any

(Optional) The example attribute shows an example value for the property. This can be used, e.g., by documentation generators to generate sample values for the property.

see

http://raml.org/spec.html#example

Optional repeat

repeat: boolean

(Optional) The repeat attribute specifies that the parameter can be repeated. If the parameter can be used multiple times, the repeat parameter value MUST be set to 'true'. Otherwise, the default value is 'false' and the parameter may not be repeated.

see

http://raml.org/spec.html#repeat

Optional required

required: boolean

(Optional except as otherwise noted) The required attribute specifies whether the parameter and its value MUST be present in the API definition. It must be either 'true' if the value MUST be present or 'false' otherwise. In general, parameters are optional unless the required attribute is included and its value set to 'true'. For a URI parameter, the required attribute MAY be omitted, but its default value is 'true'.

see

http://raml.org/spec.html#required

Optional type

type: string

(Optional) The type attribute specifies the primitive type of the parameter's resolved value. API clients MUST return/throw an error if the parameter's resolved value does not match the specified type. If type is not specified, it defaults to string.

see

http://raml.org/spec.html#type

Bodies

Bodies:

Optional application/x-www-form-urlencoded

application/x-www-form-urlencoded: WebFormBodyPayload

Optional multipart/form-data

multipart/form-data: WebFormBodyPayload

BodyPayload

BodyPayload:

Optional example

example: string
see

http://raml.org/spec.html#example-4

Optional schema

schema: SchemaName | SchemaDefinition

The structure of a request or response body MAY be further specified by the schema property under the appropriate media type.

All parsers of RAML MUST be able to interpret JSON Schema [JSON_SCHEMA] and XML Schema [XML_SCHEMA].

Alternatively, the value of the schema field MAY be the name of a schema specified in the root-level schemas property

see

http://raml.org/spec.html#schema

DocumentationItem

DocumentationItem:

Each document MUST contain title and content attributes, both of which are REQUIRED. Documentation-generators MUST process the content field as if it was defined using Markdown [MARKDOWN].

see

http://raml.org/spec.html#user-documentation

content

content: MarkdownString

title

title: string

Method

Method:

In a RESTful API, methods are operations that are performed on a resource. A method MUST be one of the HTTP methods defined in the HTTP version 1.1 specification [RFC2616] and its extension, RFC5789 [RFC5789].

see

http://raml.org/spec.html#methods

Optional body

body: Bodies

Some method verbs expect the resource to be sent as a request body. For example, to create a resource, the request must include the details of the resource to create.

Resources CAN have alternate representations. For example, an API might support both JSON and XML representations.

If the API's media type is either application/x-www-form-urlencoded or multipart/form-data, the formParameters property MUST specify the name-value pairs that the API is expecting.

see

http://raml.org/spec.html#body

Optional description

description: MarkdownString

Each declared method MAY contain a description attribute that briefly describes what the method does to the resource. It is RECOMMENDED that all API definition methods include the description property.

The value of the description property MAY be formatted using Markdown [MARKDOWN].

see

http://raml.org/spec.html#description-2

Optional headers

headers: NamedParameterMap

An API's methods MAY support or require non-standard HTTP headers. In the API definition, specify the non-standard HTTP headers by using the headers property.

see

http://raml.org/spec.html#headers

Optional is

is: TraitReference

An array of applied traits on the current resource.

https://github.com/raml-org/raml-spec/blob/master/raml-0.8.md#applying-resource-types-and-traits

method

method: HTTPMethodName

The HTTP verb corresponding to this method

Optional protocols

protocols: Protocol[]

A method can override an API's protocols value for that single method by setting a different value for the fields.

see

http://raml.org/spec.html#protocols-1

Optional queryParameters

queryParameters: NamedParameterMap

An API's resources MAY be filtered (to return a subset of results) or altered (such as transforming a response body from JSON to XML format) by the use of query strings.

If the resource or its method supports a query string, the query string MUST be defined by the queryParameters property.

see

http://raml.org/spec.html#query-strings

Optional responses

responses: Responses

Resource methods MAY have one or more responses. Responses MAY be described using the description property, and MAY include example attributes or schema properties.

see

http://raml.org/spec.html#responses

Optional securedBy

securedBy: SecuredBy

Null means that it is not secured ( it is anonymous )

NamedParameterMap

NamedParameterMap:

NumericNamedParameter

NumericNamedParameter:

Optional default

default: any

(Optional) The default attribute specifies the default value to use for the property if the property is omitted or its value is not specified. This SHOULD NOT be interpreted as a requirement for the client to send the default attribute's value if there is no other value to send. Instead, the default attribute's value is the value the server uses if the client does not send a value.

Optional description

description: MarkdownString

(Optional) The description attribute describes the intended use or meaning of the parameter. This value MAY be formatted using Markdown [MARKDOWN].

see

http://raml.org/spec.html#description

Optional displayName

displayName: string

(Optional) The displayName attribute specifies the parameter's display name. It is a friendly name used only for display or documentation purposes. If displayName is not specified, it defaults to the property's key (the name of the property itself).

see

http://raml.org/spec.html#displayname

Optional enum

enum: any[]

(Optional, applicable only for parameters of type string) The enum attribute provides an enumeration of the parameter's valid values. This MUST be an array.

If the enum attribute is defined, API clients and servers MUST verify that a parameter's value matches a value in the enum array.

If there is no matching value, the clients and servers MUST treat this as an error.

see

http://raml.org/spec.html#enum

Optional example

example: any

(Optional) The example attribute shows an example value for the property. This can be used, e.g., by documentation generators to generate sample values for the property.

see

http://raml.org/spec.html#example

Optional maximum

maximum: number

(Optional, applicable only for parameters of type number or integer) The maximum attribute specifies the parameter's maximum value.

see

http://raml.org/spec.html#maximum

Optional minimum

minimum: number

(Optional, applicable only for parameters of type number or integer) The minimum attribute specifies the parameter's minimum value.

see

http://raml.org/spec.html#minimum

Optional repeat

repeat: boolean

(Optional) The repeat attribute specifies that the parameter can be repeated. If the parameter can be used multiple times, the repeat parameter value MUST be set to 'true'. Otherwise, the default value is 'false' and the parameter may not be repeated.

see

http://raml.org/spec.html#repeat

Optional required

required: boolean

(Optional except as otherwise noted) The required attribute specifies whether the parameter and its value MUST be present in the API definition. It must be either 'true' if the value MUST be present or 'false' otherwise. In general, parameters are optional unless the required attribute is included and its value set to 'true'. For a URI parameter, the required attribute MAY be omitted, but its default value is 'true'.

see

http://raml.org/spec.html#required

Optional type

type: string

(Optional) The type attribute specifies the primitive type of the parameter's resolved value. API clients MUST return/throw an error if the parameter's resolved value does not match the specified type. If type is not specified, it defaults to string.

see

http://raml.org/spec.html#type

Resource

Resource:

Optional baseUriParameters

baseUriParameters: NamedParameterMap

A resource or a method can override a base URI template's values. This is useful to restrict or change the default or parameter selection in the base URI. The baseUriParameters property MAY be used to override any or all parameters defined at the root level baseUriParameters property, as well as base URI parameters not specified at the root level.

see

http://raml.org/spec.html#base-uri-parameters

Optional description

description: MarkdownString

Each resource, whether top-level or nested, MAY contain a description property that briefly describes the resource. It is RECOMMENDED that all the API definition's resources includes the description property.

see

http://raml.org/spec.html#description-1

Optional displayName

displayName: string

The displayName attribute provides a friendly name to the resource and can be used by documentation generation tools. The displayName key is OPTIONAL.

If the displayName attribute is not defined for a resource, documentation tools SHOULD refer to the resource by its property key (i.e. its relative URI, e.g., "/jobs"), which acts as the resource's name.

see

http://raml.org/spec.html#display-name

Optional is

is: TraitReference

An array of applied traits on the current resource.

https://github.com/raml-org/raml-spec/blob/master/raml-0.8.md#applying-resource-types-and-traits

Optional methods

methods: Method[]

In a RESTful API, methods are operations that are performed on a resource. A method MUST be one of the HTTP methods defined in the HTTP version 1.1 specification [RFC2616] and its extension, RFC5789 [RFC5789].

see

http://raml.org/spec.html#methods

relativeUri

relativeUri: string

relativeUriPathSegments

relativeUriPathSegments: string[]

This is added by the JS parser.

relativeUri = /foo/{bar}/baz/{xxx} relativeUriPathSegments = ['bar', 'xxx']

Optional resources

resources: Resource[]

Optional securedBy

securedBy: SecuredBy

Optional type

type: string | ResourceTypeReference

https://github.com/raml-org/raml-spec/blob/master/raml-0.8.md#applying-resource-types-and-traits

Optional uriParameters

uriParameters: NamedParameterMap
see

http://raml.org/spec.html#template-uris-and-uri-parameters

ResourceType

ResourceType:

Optional delete?

delete?: Method

Optional description

description: string

Optional get?

get?: Method

Optional post?

post?: Method

Optional put?

put?: Method

Optional uriParameters

uriParameters: NamedParameterMap

Response

Response:

Resource methods MAY have one or more responses.

see

http://raml.org/spec.html#responses

Optional body

body: Bodies

Optional description

description: MarkdownString

Responses MAY contain a description property that further clarifies why the response was emitted. Response descriptions are particularly useful for describing error conditions.

Optional headers

headers: NamedParameterMap

An API's methods may support custom header values in responses. The custom, non-standard HTTP headers MUST be specified by the headers property.

see

http://raml.org/spec.html#headers-1

Responses

Responses:

if the entry is null it means that the response ( for the given status code ) exists but there's no more data describing it

SecurityScheme

SecurityScheme:
see

http://raml.org/spec.html#security

Optional describedBy

describedBy: SecuritySchemeDescription

Optional description

description: MarkdownString

Optional settings

settings: object

Type declaration

  • [settingName: string]: string

Optional type

type: SecuritySchemeType

SecuritySchemeDescription

SecuritySchemeDescription:

Optional headers

headers: NamedParameterMap

Optional queryParameters

queryParameters: NamedParameterMap

Optional responses

responses: Responses

Optional uriParameters

uriParameters: NamedParameterMap

StringNamedParameter

StringNamedParameter:

Optional default

default: any

(Optional) The default attribute specifies the default value to use for the property if the property is omitted or its value is not specified. This SHOULD NOT be interpreted as a requirement for the client to send the default attribute's value if there is no other value to send. Instead, the default attribute's value is the value the server uses if the client does not send a value.

Optional description

description: MarkdownString

(Optional) The description attribute describes the intended use or meaning of the parameter. This value MAY be formatted using Markdown [MARKDOWN].

see

http://raml.org/spec.html#description

Optional displayName

displayName: string

(Optional) The displayName attribute specifies the parameter's display name. It is a friendly name used only for display or documentation purposes. If displayName is not specified, it defaults to the property's key (the name of the property itself).

see

http://raml.org/spec.html#displayname

Optional enum

enum: any[]

(Optional, applicable only for parameters of type string) The enum attribute provides an enumeration of the parameter's valid values. This MUST be an array.

If the enum attribute is defined, API clients and servers MUST verify that a parameter's value matches a value in the enum array.

If there is no matching value, the clients and servers MUST treat this as an error.

see

http://raml.org/spec.html#enum

Optional example

example: any

(Optional) The example attribute shows an example value for the property. This can be used, e.g., by documentation generators to generate sample values for the property.

see

http://raml.org/spec.html#example

Optional maxLength

maxLength: number

(Optional, applicable only for parameters of type string) The maxLength attribute specifies the parameter value's maximum number of characters.

see

http://raml.org/spec.html#maxlength

Optional minLength

minLength: number

(Optional, applicable only for parameters of type string) The minLength attribute specifies the parameter value's minimum number of characters.

see

http://raml.org/spec.html#minlength

Optional pattern

pattern: RegexPattern

(Optional, applicable only for parameters of type string)

The pattern attribute is a regular expression that a parameter of type string MUST match. The pattern MAY be enclosed in double quotes for readability and clarity. ( in the JS parser. are the quotes preserved? )

see

http://raml.org/spec.html#pattern

Optional repeat

repeat: boolean

(Optional) The repeat attribute specifies that the parameter can be repeated. If the parameter can be used multiple times, the repeat parameter value MUST be set to 'true'. Otherwise, the default value is 'false' and the parameter may not be repeated.

see

http://raml.org/spec.html#repeat

Optional required

required: boolean

(Optional except as otherwise noted) The required attribute specifies whether the parameter and its value MUST be present in the API definition. It must be either 'true' if the value MUST be present or 'false' otherwise. In general, parameters are optional unless the required attribute is included and its value set to 'true'. For a URI parameter, the required attribute MAY be omitted, but its default value is 'true'.

see

http://raml.org/spec.html#required

Optional type

type: string

(Optional) The type attribute specifies the primitive type of the parameter's resolved value. API clients MUST return/throw an error if the parameter's resolved value does not match the specified type. If type is not specified, it defaults to string.

see

http://raml.org/spec.html#type

Trait

Trait:

Optional description

description: MarkdownString

WebFormBodyPayload

WebFormBodyPayload:
see

: http://raml.org/spec.html#web-forms

Optional example

example: string
see

http://raml.org/spec.html#example-4

Optional formParameters

formParameters: NamedParameterMap

GlobalSchemas

GlobalSchemas: object[]

Type declaration

HTTPMethodName

HTTPMethodName: string

A valid HTTP method name in lowercase ( "put", "get", ... )

MarkdownString

MarkdownString: string

MediaType

MediaType: string

One of the following YAML media types:

  • text/yaml
  • text/x-yaml
  • application/yaml
  • application/x-yaml

Any type from the list of IANA MIME Media Types, http://www.iana.org/assignments/media-types A custom type that conforms to the regular expression, "application\/[A-Za-z.-0-1]*+?(json|xml)"

NamedParameter

NamedParameter: BasicNamedParameter | NumericNamedParameter | StringNamedParameter

ParameterMap

ParameterMap: object

Type declaration

  • [name: string]: string

PartialSecuritySchemeDescribedByObject

PartialSecuritySchemeDescribedByObject: object

Type declaration

  • [securitySchemeName: string]: object
    • [name: string]: any

Protocol

Protocol: string

One of: "HTTP", "HTTPS"

RegexPattern

RegexPattern: string

Regular expressions MUST follow the regular expression specification from ECMA 262/Perl 5.

ResourceTypeReference

ResourceTypeReference: string | object

SchemaDefinition

SchemaDefinition: string

JSON Schemas as strings XSDs as strings

SchemaName

SchemaName: string

SecuredBy

SecuredBy: Array<SecuritySchemeName | PartialSecuritySchemeDescribedByObject>

SecuritySchemeName

SecuritySchemeName: string

SecuritySchemeType

SecuritySchemeType: string

One of:

  • OAuth 1.0
  • OAuth 2.0
  • Basic Authentication
  • Digest Authentication
  • x-{other}
see

http://raml.org/spec.html#type-1

TraitReference

TraitReference: Array<string | object>

"typings/main/ambient/underscore/index.d"

"typings/main/ambient/underscore/index.d":

"underscore"

"underscore":

_

_:

Collection

Collection:

Dictionary

Dictionary:

List

List:

length

length: number

ListIterator

  • __call(value: T, index: number, list: List<T>): TResult

  • Parameters

    • value: T
    • index: number
    • list: List<T>

    Returns TResult

MemoIterator

  • __call(prev: TResult, curr: T, index: number, list: List<T>): TResult

  • Parameters

    • prev: TResult
    • curr: T
    • index: number
    • list: List<T>

    Returns TResult

MemoObjectIterator

  • __call(prev: TResult, curr: T, key: string, list: Dictionary<T>): TResult

  • Parameters

    • prev: TResult
    • curr: T
    • key: string
    • list: Dictionary<T>

    Returns TResult

ObjectIterator

  • __call(element: T, key: string, list: Dictionary<T>): TResult

  • Parameters

    Returns TResult

TemplateSettings

TemplateSettings:

underscore.js template settings, set templateSettings or pass as an argument to 'template()' to override defaults.

Optional escape

escape: RegExp

Default value is '/<%-([\s\S]+?)%>/g'.

Optional evaluate

evaluate: RegExp

Default value is '/<%([\s\S]+?)%>/g'.

Optional interpolate

interpolate: RegExp

Default value is '/<%=([\s\S]+?)%>/g'.

Optional variable

variable: string

By default, 'template()' places the values from your data in the local scope via the 'with' statement. However, you can specify a single variable name with this setting.

ThrottleSettings

ThrottleSettings:

underscore.js _.throttle options.

Optional leading

leading: boolean

If you'd like to disable the leading-edge call, pass this as false.

Optional trailing

trailing: boolean

If you'd like to disable the execution on the trailing-edge, pass false.

Underscore

Underscore:

after

  • after(fn: Function): Function

  • Wrapped type number.

    see

    _.after

    Parameters

    • fn: Function

    Returns Function

all

  • all(iterator?: ListIterator<T, boolean>, context?: any): boolean

  • Wrapped type any[].

    see

    _.all

    Parameters

    • Optional iterator: ListIterator<T, boolean>
    • Optional context: any

    Returns boolean

allKeys

  • allKeys(): string[]

  • Wrapped type object.

    see

    _.allKeys

    Returns string[]

any

  • any(iterator?: ListIterator<T, boolean>, context?: any): boolean

  • Wrapped type any[].

    see

    _.any

    Parameters

    • Optional iterator: ListIterator<T, boolean>
    • Optional context: any

    Returns boolean

before

  • before(fn: Function): Function

  • Wrapped type number.

    see

    _.before

    Parameters

    • fn: Function

    Returns Function

bind

  • bind(object: any, ...arguments: any[]): Function

  • Wrapped type Function.

    see

    _.bind

    Parameters

    • object: any
    • Rest ...arguments: any[]

    Returns Function

bindAll

  • bindAll(...methodNames: string[]): any

  • Wrapped type object.

    see

    _.bindAll

    Parameters

    • Rest ...methodNames: string[]

    Returns any

chain

  • Wrapped type any.

    see

    _.chain

    Returns _Chain<T>

clone

  • clone(): T

  • Wrapped type any[].

    see

    _.clone

    Returns T

collect

  • collect<TResult>(iterator: ListIterator<T, TResult>, context?: any): TResult[]
  • collect<TResult>(iterator: ObjectIterator<T, TResult>, context?: any): TResult[]
  • see

    _.map

    Type parameters

    • TResult

    Parameters

    Returns TResult[]

  • see

    _.map

    Type parameters

    • TResult

    Parameters

    Returns TResult[]

compact

  • compact(): T[]

  • Wrapped type any[].

    see

    _.compact

    Returns T[]

compose

  • compose(...functions: Function[]): Function

  • Wrapped type Function[].

    see

    _.compose

    Parameters

    • Rest ...functions: Function[]

    Returns Function

constant

  • constant(): function

  • Wrapped type any.

    see

    _.constant

    Returns function

      • (): T

      • Returns T

contains

  • contains(value: T): boolean

  • Wrapped type any[].

    see

    _.contains

    Parameters

    • value: T

    Returns boolean

countBy

  • Wrapped type any[].

    see

    _.countBy

    Parameters

    • Optional iterator: ListIterator<T, any>
    • Optional context: any

    Returns Dictionary<number>

  • Wrapped type any[].

    see

    _.countBy

    Parameters

    • iterator: string
    • Optional context: any

    Returns Dictionary<number>

debounce

  • debounce(wait: number, immediate?: boolean): Function

  • Wrapped type Function.

    see

    _.debounce

    Parameters

    • wait: number
    • Optional immediate: boolean

    Returns Function

defaults

  • defaults(...defaults: any[]): any

  • Wrapped type object.

    see

    _.defaults

    Parameters

    • Rest ...defaults: any[]

    Returns any

defer

  • defer(...arguments: any[]): void

  • Wrapped type Function.

    see

    _.defer

    Parameters

    • Rest ...arguments: any[]

    Returns void

delay

  • delay(wait: number, ...arguments: any[]): any
  • delay(...arguments: any[]): any

  • Wrapped type Function.

    see

    _.delay

    Parameters

    • wait: number
    • Rest ...arguments: any[]

    Returns any

  • see

    _.delay

    Parameters

    • Rest ...arguments: any[]

    Returns any

detect

  • detect<T>(iterator: ListIterator<T, boolean> | ObjectIterator<T, boolean>, context?: any): T
  • detect<T, U>(interator?: U): T
  • detect<T>(interator?: string): T
  • see

    _.find

    Type parameters

    • T

    Parameters

    Returns T

  • see

    _.find

    Type parameters

    • T

    • U: object

    Parameters

    • Optional interator: U

    Returns T

  • see

    _.find

    Type parameters

    • T

    Parameters

    • Optional interator: string

    Returns T

difference

  • difference(...others: List<T>[]): T[]

  • Wrapped type any[].

    see

    _.difference

    Parameters

    • Rest ...others: List<T>[]

    Returns T[]

drop

  • drop(n?: number): T[]
  • see

    _.rest

    Parameters

    • Optional n: number

    Returns T[]

each

  • Wrapped type any[].

    see

    _.each

    Parameters

    Returns T[]

  • see

    _.each

    Parameters

    Returns T[]

escape

  • escape(): string

  • Wrapped type string.

    see

    _.escape

    Returns string

every

  • every(iterator?: ListIterator<T, boolean>, context?: any): boolean
  • see

    _.all

    Parameters

    • Optional iterator: ListIterator<T, boolean>
    • Optional context: any

    Returns boolean

extend

  • extend(...sources: any[]): any

  • Wrapped type object.

    see

    _.extend

    Parameters

    • Rest ...sources: any[]

    Returns any

filter

  • filter(iterator: ListIterator<T, boolean>, context?: any): T[]

  • Wrapped type any[].

    see

    _.filter

    Parameters

    Returns T[]

find

  • find<T>(iterator: ListIterator<T, boolean> | ObjectIterator<T, boolean>, context?: any): T
  • find<T, U>(interator: U): T
  • find<T>(interator: string): T

  • Wrapped type any[].

    see

    _.find

    Type parameters

    • T

    Parameters

    Returns T

  • see

    _.find

    Type parameters

    • T

    • U: object

    Parameters

    • interator: U

    Returns T

  • see

    _.find

    Type parameters

    • T

    Parameters

    • interator: string

    Returns T

findIndex

  • findIndex<T>(array: List<T>, predicate: ListIterator<T, boolean>, context?: any): number
  • see

    _.findIndex

    Type parameters

    • T

    Parameters

    Returns number

findLastIndex

  • findLastIndex<T>(array: List<T>, predicate: ListIterator<T, boolean>, context?: any): number
  • see

    _.findLastIndex

    Type parameters

    • T

    Parameters

    Returns number

findWhere

  • findWhere<U>(properties: U): T

  • Wrapped type any[].

    see

    _.findWhere

    Type parameters

    • U: object

    Parameters

    • properties: U

    Returns T

first

  • first(): T
  • first(n: number): T[]

  • Wrapped type any[].

    see

    _.first

    Returns T

  • Wrapped type any[].

    see

    _.first

    Parameters

    • n: number

    Returns T[]

flatten

  • flatten(shallow?: boolean): any[]

  • Wrapped type any.

    see

    _.flatten

    Parameters

    • Optional shallow: boolean

    Returns any[]

foldl

  • foldl<TResult>(iterator: MemoIterator<T, TResult>, memo?: TResult, context?: any): TResult
  • see

    _.reduce

    Type parameters

    • TResult

    Parameters

    • iterator: MemoIterator<T, TResult>
    • Optional memo: TResult
    • Optional context: any

    Returns TResult

foldr

  • foldr<TResult>(iterator: MemoIterator<T, TResult>, memo?: TResult, context?: any): TResult
  • see

    _.reduceRight

    Type parameters

    • TResult

    Parameters

    • iterator: MemoIterator<T, TResult>
    • Optional memo: TResult
    • Optional context: any

    Returns TResult

forEach

  • see

    _.each

    Parameters

    Returns T[]

  • see

    _.each

    Parameters

    Returns T[]

functions

  • functions(): string[]

  • Wrapped type object.

    see

    _.functions

    Returns string[]

groupBy

  • Wrapped type any[].

    see

    _.groupBy

    Parameters

    • Optional iterator: ListIterator<T, any>
    • Optional context: any

    Returns Dictionary<List<T>>

  • Wrapped type any[].

    see

    _.groupBy

    Parameters

    • iterator: string
    • Optional context: any

    Returns Dictionary<T[]>

has

  • has(key: string): boolean

  • Wrapped type object.

    see

    _.has

    Parameters

    • key: string

    Returns boolean

head

  • head(): T
  • head(n: number): T[]
  • see

    _.first

    Returns T

  • see

    _.first

    Parameters

    • n: number

    Returns T[]

identity

  • identity(): any

  • Wrapped type any.

    see

    _.identity

    Returns any

include

  • include(value: T): boolean

  • Alias for 'contains'.

    see

    contains

    Parameters

    • value: T

    Returns boolean

indexBy

  • Wrapped type any[].

    see

    _.indexBy

    Parameters

    Returns Dictionary<T>

  • Wrapped type any[].

    see

    _.indexBy

    Parameters

    • iterator: string
    • Optional context: any

    Returns Dictionary<T>

indexOf

  • indexOf(value: T, isSorted?: boolean): number
  • indexOf(value: T, startFrom: number): number

  • Wrapped type any[].

    see

    _.indexOf

    Parameters

    • value: T
    • Optional isSorted: boolean

    Returns number

  • see

    _.indexOf

    Parameters

    • value: T
    • startFrom: number

    Returns number

initial

  • initial(n?: number): T[]

  • Wrapped type any[].

    see

    _.initial

    Parameters

    • Optional n: number

    Returns T[]

inject

  • inject<TResult>(iterator: MemoIterator<T, TResult>, memo?: TResult, context?: any): TResult
  • see

    _.reduce

    Type parameters

    • TResult

    Parameters

    • iterator: MemoIterator<T, TResult>
    • Optional memo: TResult
    • Optional context: any

    Returns TResult

intersection

  • intersection(...arrays: List<T>[]): T[]

  • Wrapped type any[][].

    see

    _.intersection

    Parameters

    • Rest ...arrays: List<T>[]

    Returns T[]

invert

  • invert(): any

  • Wrapped type object.

    see

    _.invert

    Returns any

invoke

  • invoke(methodName: string, ...arguments: any[]): any

  • Wrapped type any[].

    see

    _.invoke

    Parameters

    • methodName: string
    • Rest ...arguments: any[]

    Returns any

isArguments

  • isArguments(): boolean

  • Wrapped type object.

    see

    _.isArguments

    Returns boolean

isArray

  • isArray(): boolean

  • Wrapped type object.

    see

    _.isArray

    Returns boolean

isBoolean

  • isBoolean(): boolean

  • Wrapped type object.

    see

    _.isBoolean

    Returns boolean

isDate

  • isDate(): boolean

  • Wrapped type object.

    see

    _.isDate

    Returns boolean

isElement

  • isElement(): boolean

  • Wrapped type object.

    see

    _.isElement

    Returns boolean

isEmpty

  • isEmpty(): boolean

  • Wrapped type object.

    see

    _.isEmpty

    Returns boolean

isEqual

  • isEqual(other: any): boolean

  • Wrapped type object.

    see

    _.isEqual

    Parameters

    • other: any

    Returns boolean

isError

  • isError(): boolean

  • Wrapped type object.

    see

    _.isError

    Returns boolean

isFinite

  • isFinite(): boolean

  • Wrapped type object.

    see

    _.isFinite

    Returns boolean

isFunction

  • isFunction(): boolean

  • Wrapped type object.

    see

    _.isFunction

    Returns boolean

isMatch

  • isMatch(): boolean

  • Wrapped type object.

    see

    _.isMatch

    Returns boolean

isNaN

  • isNaN(): boolean

  • Wrapped type object.

    see

    _.isNaN

    Returns boolean

isNull

  • isNull(): boolean

  • Wrapped type object.

    see

    _.isNull

    Returns boolean

isNumber

  • isNumber(): boolean

  • Wrapped type object.

    see

    _.isNumber

    Returns boolean

isObject

  • isObject(): boolean

  • Wrapped type object.

    see

    _.isObject

    Returns boolean

isRegExp

  • isRegExp(): boolean

  • Wrapped type object.

    see

    _.isRegExp

    Returns boolean

isString

  • isString(): boolean

  • Wrapped type object.

    see

    _.isString

    Returns boolean

isUndefined

  • isUndefined(): boolean

  • Wrapped type object.

    see

    _.isUndefined

    Returns boolean

iteratee

  • iteratee(context?: any, argCount?: number): Function

  • Wrapped type string|Function|Object.

    see

    _.iteratee

    Parameters

    • Optional context: any
    • Optional argCount: number

    Returns Function

keys

  • keys(): string[]

  • Wrapped type object.

    see

    _.keys

    Returns string[]

last

  • last(): T
  • last(n: number): T[]

  • Wrapped type any[].

    see

    _.last

    Returns T

  • Wrapped type any[].

    see

    _.last

    Parameters

    • n: number

    Returns T[]

lastIndexOf

  • lastIndexOf(value: T, from?: number): number

  • Wrapped type any[].

    see

    _.lastIndexOf

    Parameters

    • value: T
    • Optional from: number

    Returns number

map

  • map<TResult>(iterator: ListIterator<T, TResult>, context?: any): TResult[]
  • map<TResult>(iterator: ObjectIterator<T, TResult>, context?: any): TResult[]

  • Wrapped type any[].

    see

    _.map

    Type parameters

    • TResult

    Parameters

    Returns TResult[]

  • Wrapped type any[].

    see

    _.map

    Type parameters

    • TResult

    Parameters

    Returns TResult[]

matches

  • Wrapped type any[].

    see

    _.matches

    Type parameters

    • TResult

    Returns ListIterator<T, TResult>

max

  • max(): number
  • max(iterator: ListIterator<T, number>, context?: any): T
  • max(iterator?: ListIterator<T, any>, context?: any): T

  • Wrapped type number[].

    see

    _.max

    Returns number

  • Wrapped type any[].

    see

    _.max

    Parameters

    Returns T

  • Wrapped type any[].

    see

    _.max

    Parameters

    • Optional iterator: ListIterator<T, any>
    • Optional context: any

    Returns T

memoize

  • memoize(hashFn?: function): Function

  • Wrapped type Function.

    see

    _.memoize

    Parameters

    • Optional hashFn: function
        • (n: any): string

        • Parameters

          • n: any

          Returns string

    Returns Function

methods

  • methods(): string[]
  • see

    _.functions

    Returns string[]

min

  • min(): number
  • min(iterator: ListIterator<T, number>, context?: any): T
  • min(iterator?: ListIterator<T, any>, context?: any): T

  • Wrapped type number[].

    see

    _.min

    Returns number

  • Wrapped type any[].

    see

    _.min

    Parameters

    Returns T

  • Wrapped type any[].

    see

    _.min

    Parameters

    • Optional iterator: ListIterator<T, any>
    • Optional context: any

    Returns T

mixin

  • mixin(): void

  • Wrapped type object.

    see

    _.mixin

    Returns void

negate

  • negate(): boolean

  • Wrapped type Function.

    see

    _.negate

    Returns boolean

noop

  • noop(): void

  • Wrapped type any.

    see

    _.noop

    Returns void

object

  • object(...keyValuePairs: any[]): any
  • object(values?: any): any

  • Wrapped type any[][].

    see

    _.object

    Parameters

    • Rest ...keyValuePairs: any[]

    Returns any

  • see

    _.object

    Parameters

    • Optional values: any

    Returns any

omit

  • omit(...keys: string[]): any
  • omit(keys: string[]): any
  • omit(fn: Function): any

  • Wrapped type object.

    see

    _.omit

    Parameters

    • Rest ...keys: string[]

    Returns any

  • Parameters

    • keys: string[]

    Returns any

  • Parameters

    • fn: Function

    Returns any

once

  • once(): Function

  • Wrapped type Function.

    see

    _.once

    Returns Function

pairs

  • pairs(): any[]

  • Wrapped type object.

    see

    _.pairs

    Returns any[]

partial

  • partial(...arguments: any[]): Function

  • Wrapped type Function.

    see

    _.partial

    Parameters

    • Rest ...arguments: any[]

    Returns Function

partition

  • partition(iterator: ListIterator<T, boolean>, context?: any): T[]

  • Wrapped type any[].

    see

    _.partition

    Parameters

    Returns T[]

pick

  • pick(...keys: any[]): any
  • pick(keys: any[]): any
  • pick(fn: function): any

  • Wrapped type object.

    see

    _.pick

    Parameters

    • Rest ...keys: any[]

    Returns any

  • Parameters

    • keys: any[]

    Returns any

  • Parameters

    • fn: function
        • (value: any, key: any, object: any): any

        • Parameters

          • value: any
          • key: any
          • object: any

          Returns any

    Returns any

pluck

  • pluck(propertyName: string): any[]

  • Wrapped type any[].

    see

    _.pluck

    Parameters

    • propertyName: string

    Returns any[]

property

  • property(): function

  • Wrapped type string.

    see

    _.property

    Returns function

      • (object: Object): any

      • Parameters

        • object: Object

        Returns any

propertyOf

  • propertyOf(): function

  • Wrapped type object.

    see

    _.propertyOf

    Returns function

      • (key: string): any

      • Parameters

        • key: string

        Returns any

random

  • random(): number
  • random(max: number): number

  • Wrapped type number.

    see

    _.random

    Returns number

  • Wrapped type number.

    see

    _.random

    Parameters

    • max: number

    Returns number

range

  • range(stop: number, step?: number): number[]
  • range(): number[]

  • Wrapped type number.

    see

    _.range

    Parameters

    • stop: number
    • Optional step: number

    Returns number[]

  • Wrapped type number.

    see

    _.range

    Returns number[]

reduce

  • reduce<TResult>(iterator: MemoIterator<T, TResult>, memo?: TResult, context?: any): TResult

  • Wrapped type any[].

    see

    _.reduce

    Type parameters

    • TResult

    Parameters

    • iterator: MemoIterator<T, TResult>
    • Optional memo: TResult
    • Optional context: any

    Returns TResult

reduceRight

  • reduceRight<TResult>(iterator: MemoIterator<T, TResult>, memo?: TResult, context?: any): TResult

  • Wrapped type any[].

    see

    _.reduceRight

    Type parameters

    • TResult

    Parameters

    • iterator: MemoIterator<T, TResult>
    • Optional memo: TResult
    • Optional context: any

    Returns TResult

reject

  • reject(iterator: ListIterator<T, boolean>, context?: any): T[]

  • Wrapped type any[].

    see

    _.reject

    Parameters

    Returns T[]

rest

  • rest(n?: number): T[]

  • Wrapped type any[].

    see

    _.rest

    Parameters

    • Optional n: number

    Returns T[]

result

  • result(property: string, defaultValue?: any): any

  • Wrapped type object.

    see

    _.result

    Parameters

    • property: string
    • Optional defaultValue: any

    Returns any

sample

  • sample<T>(n: number): T[]
  • sample<T>(): T

  • Wrapped type any[].

    see

    _.sample

    Type parameters

    • T

    Parameters

    • n: number

    Returns T[]

  • see

    _.sample

    Type parameters

    • T

    Returns T

select

  • select(iterator: ListIterator<T, boolean>, context?: any): T[]
  • see

    _.filter

    Parameters

    Returns T[]

shuffle

  • shuffle(): T[]

  • Wrapped type any[].

    see

    _.shuffle

    Returns T[]

size

  • size(): number

  • Wrapped type any.

    see

    _.size

    Returns number

some

  • some(iterator?: ListIterator<T, boolean>, context?: any): boolean
  • see

    _.any

    Parameters

    • Optional iterator: ListIterator<T, boolean>
    • Optional context: any

    Returns boolean

sortBy

  • sortBy(iterator?: ListIterator<T, any>, context?: any): T[]
  • sortBy(iterator: string, context?: any): T[]

  • Wrapped type any[].

    see

    _.sortBy

    Parameters

    • Optional iterator: ListIterator<T, any>
    • Optional context: any

    Returns T[]

  • Wrapped type any[].

    see

    _.sortBy

    Parameters

    • iterator: string
    • Optional context: any

    Returns T[]

sortedIndex

  • sortedIndex(value: T, iterator?: function, context?: any): number

  • Wrapped type any[].

    see

    _.sortedIndex

    Parameters

    • value: T
    • Optional iterator: function
        • (x: T): any

        • Parameters

          • x: T

          Returns any

    • Optional context: any

    Returns number

tail

  • tail(n?: number): T[]
  • see

    _.rest

    Parameters

    • Optional n: number

    Returns T[]

take

  • take(): T
  • take(n: number): T[]
  • see

    _.first

    Returns T

  • see

    _.first

    Parameters

    • n: number

    Returns T[]

tap

  • tap(interceptor: function): any

  • Wrapped type object.

    see

    _.tap

    Parameters

    • interceptor: function
        • (...as: any[]): any

        • Parameters

          • Rest ...as: any[]

          Returns any

    Returns any

template

  • Wrapped type string.

    see

    _.template

    Parameters

    Returns function

      • (...data: any[]): string

      • Parameters

        • Rest ...data: any[]

        Returns string

throttle

  • Wrapped type Function.

    see

    _.throttle

    Parameters

    Returns Function

times

  • times<TResult>(iterator: function, context?: any): TResult[]

  • Wrapped type number.

    see

    _.times

    Type parameters

    • TResult

    Parameters

    • iterator: function
        • (n: number): TResult

        • Parameters

          • n: number

          Returns TResult

    • Optional context: any

    Returns TResult[]

toArray

  • toArray(): T[]

  • Wrapped type any.

    see

    _.toArray

    Returns T[]

unescape

  • unescape(): string

  • Wrapped type string.

    see

    _.unescape

    Returns string

union

  • union(...arrays: List<T>[]): T[]

  • Wrapped type any[][].

    see

    _.union

    Parameters

    • Rest ...arrays: List<T>[]

    Returns T[]

uniq

  • uniq(isSorted?: boolean, iterator?: ListIterator<T, any>): T[]
  • uniq<TSort>(iterator?: ListIterator<T, TSort>, context?: any): T[]

  • Wrapped type any[].

    see

    _.uniq

    Parameters

    • Optional isSorted: boolean
    • Optional iterator: ListIterator<T, any>

    Returns T[]

  • Wrapped type any[].

    see

    _.uniq

    Type parameters

    • TSort

    Parameters

    • Optional iterator: ListIterator<T, TSort>
    • Optional context: any

    Returns T[]

unique

  • unique<TSort>(isSorted?: boolean, iterator?: ListIterator<T, TSort>): T[]
  • unique<TSort>(iterator?: ListIterator<T, TSort>, context?: any): T[]
  • see

    _.uniq

    Type parameters

    • TSort

    Parameters

    • Optional isSorted: boolean
    • Optional iterator: ListIterator<T, TSort>

    Returns T[]

  • see

    _.uniq

    Type parameters

    • TSort

    Parameters

    • Optional iterator: ListIterator<T, TSort>
    • Optional context: any

    Returns T[]

uniqueId

  • uniqueId(): string

  • Wrapped type string.

    see

    _.uniqueId

    Returns string

unzip

  • unzip(...arrays: any[]): any[]

  • Wrapped type any[][].

    see

    _.unzip

    Parameters

    • Rest ...arrays: any[]

    Returns any[]

value

  • value<TResult>(): TResult

  • Wrapped type any. Extracts the value of a wrapped object.

    Type parameters

    • TResult

    Returns TResult

    Value of the wrapped object.

values

  • values(): T[]

  • Wrapped type object.

    see

    _.values

    Returns T[]

where

  • where<U>(properties: U): T[]

  • Wrapped type any[].

    see

    _.where

    Type parameters

    • U: object

    Parameters

    • properties: U

    Returns T[]

without

  • without(...values: T[]): T[]

  • Wrapped type any[].

    see

    _.without

    Parameters

    • Rest ...values: T[]

    Returns T[]

wrap

  • wrap(wrapper: Function): function

  • Wrapped type Function.

    see

    _.wrap

    Parameters

    • wrapper: Function

    Returns function

      • (): Function

      • Returns Function

zip

  • zip(...arrays: any[]): any[]

  • Wrapped type any[][].

    see

    _.zip

    Parameters

    • Rest ...arrays: any[]

    Returns any[]

Export assignment UnderscoreStatic

  • Underscore OOP Wrapper, all Underscore functions that take an object as the first parameter can be invoked through this function.

    Type parameters

    • T

    Parameters

    Returns Underscore<T>

  • Type parameters

    • T

    Parameters

    • value: Array<T>

    Returns Underscore<T>

  • Type parameters

    • T

    Parameters

    • value: T

    Returns Underscore<T>

templateSettings

templateSettings: TemplateSettings

By default, Underscore uses ERB-style template delimiters, change the following template settings to use alternative delimiters.

after

  • after(count: number, fn: Function): Function

  • Creates a version of the function that will only be run after first being called count times. Useful for grouping asynchronous responses, where you want to be sure that all the async calls have finished, before proceeding.

    Parameters

    • count: number
    • fn: Function

    Returns Function

    Copy of fn that will not execute until it is invoked count times.

all

  • see

    _.every

    Type parameters

    • T

    Parameters

    • list: List<T>
    • Optional iterator: ListIterator<T, boolean>
    • Optional context: any

    Returns boolean

  • see

    _.every

    Type parameters

    • T

    Parameters

    Returns boolean

allKeys

  • allKeys(object: any): string[]

  • Retrieve all the names of object's own and inherited properties.

    Parameters

    • object: any

      Retrieve the key or property names from this object.

    Returns string[]

    List of all the property names on object.

any

  • see

    _.some

    Type parameters

    • T

    Parameters

    • list: List<T>
    • Optional iterator: ListIterator<T, boolean>
    • Optional context: any

    Returns boolean

  • see

    _.some

    Type parameters

    • T

    Parameters

    Returns boolean

assign

  • assign(destination: any, ...source: any[]): any

  • Like extend, but only copies own properties over to the destination object. (alias: extendOwn)

    Parameters

    • destination: any
    • Rest ...source: any[]

    Returns any

before

  • before(count: number, fn: Function): Function

  • Creates a version of the function that can be called no more than count times. The result of the last function call is memoized and returned when count has been reached.

    Parameters

    • count: number
    • fn: Function

    Returns Function

    Copy of fn that can only be called count times.

bind

  • bind(func: Function, context: any, ...arguments: any[]): function

  • Bind a function to an object, meaning that whenever the function is called, the value of this will be the object. Optionally, bind arguments to the function to pre-fill them, also known as partial application.

    Parameters

    • func: Function

      The function to bind this to object.

    • context: any

      The this pointer whenever fn is called.

    • Rest ...arguments: any[]

      Additional arguments to pass to fn when called.

    Returns function

    fn with this bound to object.

      • (): any

      • Returns any

bindAll

  • bindAll(object: any, ...methodNames: string[]): any

  • Binds a number of methods on the object, specified by methodNames, to be run in the context of that object whenever they are invoked. Very handy for binding functions that are going to be used as event handlers, which would otherwise be invoked with a fairly useless this. If no methodNames are provided, all of the object's function properties will be bound to it.

    Parameters

    • object: any

      The object to bind the methods methodName to.

    • Rest ...methodNames: string[]

      The methods to bind to object, optional and if not provided all of object's methods are bound.

    Returns any

chain

  • Returns a wrapped object. Calling methods on this object will continue to return wrapped objects until value() is used.

    Type parameters

    • T

    Parameters

    • obj: T[]

      Object to chain.

    Returns _Chain<T>

    Wrapped obj.

  • Type parameters

    • T

    Parameters

    Returns _Chain<T>

  • Type parameters

    • T: object

    Parameters

    • obj: T

    Returns _Chain<T>

clone

  • clone<T>(object: T): T

  • Create a shallow-copied clone of the object. Any nested objects or arrays will be copied by reference, not duplicated.

    Type parameters

    • T

    Parameters

    • object: T

      Object to clone.

    Returns T

    Copy of object.

collect

  • collect<T, TResult>(list: List<T>, iterator: ListIterator<T, TResult>, context?: any): TResult[]
  • collect<T, TResult>(object: Dictionary<T>, iterator: ObjectIterator<T, TResult>, context?: any): TResult[]
  • see

    _.map

    Type parameters

    • T

    • TResult

    Parameters

    Returns TResult[]

  • see

    _.map

    Type parameters

    • T

    • TResult

    Parameters

    Returns TResult[]

compact

  • compact<T>(array: List<T>): T[]

  • Returns a copy of the array with all falsy values removed. In JavaScript, false, null, 0, "", undefined and NaN are all falsy.

    Type parameters

    • T

    Parameters

    • array: List<T>

      Array to compact.

    Returns T[]

    Copy of array without false values.

compose

  • compose(...functions: Function[]): Function

  • Returns the composition of a list of functions, where each function consumes the return value of the function that follows. In math terms, composing the functions f(), g(), and h() produces f(g(h())).

    Parameters

    • Rest ...functions: Function[]

      List of functions to compose.

    Returns Function

    Composition of functions.

constant

  • constant<T>(value: T): function

  • Creates a function that returns the same value that is used as the argument of _.constant

    Type parameters

    • T

    Parameters

    • value: T

      Identity of this object.

    Returns function

    Function that return value.

      • (): T

      • Returns T

contains

  • contains<T>(list: List<T>, value: T): boolean
  • contains<T>(object: Dictionary<T>, value: T): boolean

  • Returns true if the value is present in the list. Uses indexOf internally, if list is an Array.

    Type parameters

    • T

    Parameters

    • list: List<T>

      Checks each element to see if value is present.

    • value: T

      The value to check for within list.

    Returns boolean

    True if value is present in list, otherwise false.

  • see

    _.contains

    Type parameters

    • T

    Parameters

    Returns boolean

countBy

  • Sorts a list into groups and returns a count for the number of objects in each group. Similar to groupBy, but instead of returning a list of values, returns a count for the number of values in that group.

    Type parameters

    • T

    Parameters

    • list: List<T>

      Group elements in this list and then count the number of elements in each group.

    • Optional iterator: ListIterator<T, any>

      Group iterator for each element within list, return the key to group the element by.

    • Optional context: any

      this object in iterator, optional.

    Returns Dictionary<number>

    An object with the group names as properties where each property contains the number of elements in that group.

  • see

    _.countBy

    Type parameters

    • T

    Parameters

    • list: List<T>
    • iterator: string

      Function name

    • Optional context: any

    Returns Dictionary<number>

debounce

  • debounce<T>(fn: T, wait: number, immediate?: boolean): T

  • Creates and returns a new debounced version of the passed function that will postpone its execution until after wait milliseconds have elapsed since the last time it was invoked. Useful for implementing behavior that should only happen after the input has stopped arriving. For example: rendering a preview of a Markdown comment, recalculating a layout after the window has stopped being resized, and so on.

    Pass true for the immediate parameter to cause debounce to trigger the function on the leading instead of the trailing edge of the wait interval. Useful in circumstances like preventing accidental double -clicks on a "submit" button from firing a second time.

    Type parameters

    • T: Function

    Parameters

    • fn: T

      Function to debounce waitMS ms.

    • wait: number

      The number of milliseconds to wait before fn can be invoked again.

    • Optional immediate: boolean

      True if fn should be invoked on the leading edge of waitMS instead of the trailing edge.

    Returns T

    Debounced version of fn that waits wait ms when invoked.

defaults

  • defaults(object: any, ...defaults: any[]): any

  • Fill in null and undefined properties in object with values from the defaults objects, and return the object. As soon as the property is filled, further defaults will have no effect.

    Parameters

    • object: any

      Fill this object with default values.

    • Rest ...defaults: any[]

      The default values to add to object.

    Returns any

    object with added defaults values.

defer

  • defer(fn: Function, ...arguments: any[]): void

  • Defers invoking the function until the current call stack has cleared, similar to using setTimeout with a delay of 0. Useful for performing expensive computations or HTML rendering in chunks without blocking the UI thread from updating. If you pass the optional arguments, they will be forwarded on to the function when it is invoked.

    Parameters

    • fn: Function

      The function to defer.

    • Rest ...arguments: any[]

      Additional arguments to pass to fn.

    Returns void

delay

  • delay(func: Function, wait: number, ...arguments: any[]): any
  • delay(func: Function, ...arguments: any[]): any

  • Much like setTimeout, invokes function after wait milliseconds. If you pass the optional arguments, they will be forwarded on to the function when it is invoked.

    arguments

    Additional arguments to pass to fn.

    Parameters

    • func: Function

      Function to delay waitMS amount of ms.

    • wait: number

      The amount of milliseconds to delay fn.

    • Rest ...arguments: any[]

    Returns any

  • see

    _delay

    Parameters

    • func: Function
    • Rest ...arguments: any[]

    Returns any

detect

  • see

    _.find

    Type parameters

    • T

    Parameters

    Returns T

  • see

    _.find

    Type parameters

    • T

    Parameters

    Returns T

  • see

    _.find

    Type parameters

    • T

    • U: object

    Parameters

    Returns T

  • see

    _.find

    Type parameters

    • T

    Parameters

    Returns T

difference

  • difference<T>(array: List<T>, ...others: List<T>[]): T[]

  • Similar to without, but returns the values from array that are not present in the other arrays.

    Type parameters

    • T

    Parameters

    • array: List<T>

      Keeps values that are within others.

    • Rest ...others: List<T>[]

      The values to keep within array.

    Returns T[]

    Copy of array with only others values.

drop

  • drop<T>(array: List<T>, n?: number): T[]
  • see

    _.rest

    Type parameters

    • T

    Parameters

    • array: List<T>
    • Optional n: number

    Returns T[]

each

  • Iterates over a list of elements, yielding each in turn to an iterator function. The iterator is bound to the context object, if one is passed. Each invocation of iterator is called with three arguments: (element, index, list). If list is a JavaScript object, iterator's arguments will be (value, key, object). Delegates to the native forEach function if it exists.

    Type parameters

    • T

    Parameters

    • list: List<T>

      Iterates over this list of elements.

    • iterator: ListIterator<T, void>

      Iterator function for each element list.

    • Optional context: any

      'this' object in iterator, optional.

    Returns List<T>

  • see

    _.each

    Type parameters

    • T

    Parameters

    • object: Dictionary<T>

      Iterates over properties of this object.

    • iterator: ObjectIterator<T, void>

      Iterator function for each property on object.

    • Optional context: any

      'this' object in iterator, optional.

    Returns Dictionary<T>

escape

  • escape(str: string): string

  • Escapes a string for insertion into HTML, replacing &, <, >, ", ', and / characters.

    Parameters

    • str: string

      Raw string to escape.

    Returns string

    str HTML escaped.

every

  • Returns true if all of the values in the list pass the iterator truth test. Delegates to the native method every, if present.

    Type parameters

    • T

    Parameters

    • list: List<T>

      Truth test against all elements within this list.

    • Optional iterator: ListIterator<T, boolean>

      Trust test iterator function for each element in list.

    • Optional context: any

      this object in iterator, optional.

    Returns boolean

    True if all elements passed the truth test, otherwise false.

  • see

    _.every

    Type parameters

    • T

    Parameters

    Returns boolean

extend

  • extend(destination: any, ...sources: any[]): any

  • Copy all of the properties in the source objects over to the destination object, and return the destination object. It's in-order, so the last source will override properties of the same name in previous arguments.

    Parameters

    • destination: any

      Object to extend all the properties from sources.

    • Rest ...sources: any[]

      Extends destination with all properties from these source objects.

    Returns any

    destination extended with all the properties from the sources objects.

extendOwn

  • extendOwn(destination: any, ...source: any[]): any

  • Like extend, but only copies own properties over to the destination object. (alias: assign)

    Parameters

    • destination: any
    • Rest ...source: any[]

    Returns any

filter

  • Looks through each value in the list, returning an array of all the values that pass a truth test (iterator). Delegates to the native filter method, if it exists.

    Type parameters

    • T

    Parameters

    • list: List<T>

      Filter elements out of this list.

    • iterator: ListIterator<T, boolean>

      Filter iterator function for each element in list.

    • Optional context: any

      this object in iterator, optional.

    Returns T[]

    The filtered list of elements.

  • see

    _.filter

    Type parameters

    • T

    Parameters

    Returns T[]

find

  • Looks through each value in the list, returning the first one that passes a truth test (iterator). The function returns as soon as it finds an acceptable element, and doesn't traverse the entire list.

    Type parameters

    • T

    Parameters

    • list: List<T>

      Searches for a value in this list.

    • iterator: ListIterator<T, boolean>

      Search iterator function for each element in list.

    • Optional context: any

      this object in iterator, optional.

    Returns T

    The first acceptable found element in list, if nothing is found undefined/null is returned.

  • see

    _.find

    Type parameters

    • T

    Parameters

    Returns T

  • see

    _.find

    Type parameters

    • T

    • U: object

    Parameters

    Returns T

  • see

    _.find

    Type parameters

    • T

    Parameters

    Returns T

findIndex

  • findIndex<T>(list: List<T>, iterator: ListIterator<T, boolean>, context?: any): number
  • findIndex<T>(array: List<T>, predicate: ListIterator<T, boolean>, context?: any): number

  • Looks through each value in the list, returning the index of the first one that passes a truth test (iterator). The function returns as soon as it finds an acceptable element, and doesn't traverse the entire list.

    Type parameters

    • T

    Parameters

    • list: List<T>

      Searches for a value in this list.

    • iterator: ListIterator<T, boolean>

      Search iterator function for each element in list.

    • Optional context: any

      this object in iterator, optional.

    Returns number

    The index of the first acceptable found element in list, if nothing is found -1 is returned.

  • Returns the first index of an element in array where the predicate truth test passes

    Type parameters

    • T

    Parameters

    • array: List<T>

      The array to search for the index of the first element where the predicate truth test passes.

    • predicate: ListIterator<T, boolean>

      Predicate function.

    • Optional context: any

      this object in predicate, optional.

    Returns number

    Returns the index of an element in array where the predicate truth test passes or -1.`

findLastIndex

  • findLastIndex<T>(array: List<T>, predicate: ListIterator<T, boolean>, context?: any): number

  • Returns the last index of an element in array where the predicate truth test passes

    Type parameters

    • T

    Parameters

    • array: List<T>

      The array to search for the index of the last element where the predicate truth test passes.

    • predicate: ListIterator<T, boolean>

      Predicate function.

    • Optional context: any

      this object in predicate, optional.

    Returns number

    Returns the index of an element in array where the predicate truth test passes or -1.`

findWhere

  • findWhere<T, U>(list: List<T>, properties: U): T

  • Looks through the list and returns the first value that matches all of the key-value pairs listed in properties.

    Type parameters

    • T

    • U: object

    Parameters

    • list: List<T>

      Search through this list's elements for the first object with all properties.

    • properties: U

      Properties to look for on the elements within list.

    Returns T

    The first element in list that has all properties.

first

  • first<T>(array: List<T>): T
  • first<T>(array: List<T>, n: number): T[]

  • Returns the first element of an array. Passing n will return the first n elements of the array.

    Type parameters

    • T

    Parameters

    • array: List<T>

      Retrieves the first element of this array.

    Returns T

    Returns the first element of array.

  • see

    _.first

    Type parameters

    • T

    Parameters

    • array: List<T>
    • n: number

      Return more than one element from array.

    Returns T[]

flatten

  • flatten(array: List<any>, shallow?: boolean): any[]

  • Flattens a nested array (the nesting can be to any depth). If you pass shallow, the array will only be flattened a single level.

    Parameters

    • array: List<any>

      The array to flatten.

    • Optional shallow: boolean

      If true then only flatten one level, optional, default = false.

    Returns any[]

    array flattened.

foldl

  • foldl<T, TResult>(list: Collection<T>, iterator: MemoIterator<T, TResult>, memo?: TResult, context?: any): TResult
  • see

    _.reduce

    Type parameters

    • T

    • TResult

    Parameters

    Returns TResult

foldr

  • foldr<T, TResult>(list: Collection<T>, iterator: MemoIterator<T, TResult>, memo?: TResult, context?: any): TResult
  • see

    _.reduceRight

    Type parameters

    • T

    • TResult

    Parameters

    Returns TResult

forEach

  • see

    _.each

    Type parameters

    • T

    Parameters

    Returns List<T>

  • see

    _.each

    Type parameters

    • T

    Parameters

    Returns Dictionary<T>

functions

  • functions(object: any): string[]

  • Returns a sorted list of the names of every method in an object - that is to say, the name of every function property of the object.

    Parameters

    • object: any

      Object to pluck all function property names from.

    Returns string[]

    List of all the function names on object.

groupBy

  • Splits a collection into sets, grouped by the result of running each value through iterator. If iterator is a string instead of a function, groups by the property named by iterator on each of the values.

    Type parameters

    • T

    Parameters

    • list: List<T>

      Groups this list.

    • Optional iterator: ListIterator<T, any>

      Group iterator for each element within list, return the key to group the element by.

    • Optional context: any

      this object in iterator, optional.

    Returns Dictionary<T[]>

    An object with the group names as properties where each property contains the grouped elements from list.

  • see

    _.groupBy

    Type parameters

    • T

    Parameters

    • list: List<T>
    • iterator: string

      Property on each object to group them by.

    • Optional context: any

    Returns Dictionary<T[]>

has

  • has(object: any, key: string): boolean

  • Does the object contain the given key? Identical to object.hasOwnProperty(key), but uses a safe reference to the hasOwnProperty function, in case it's been overridden accidentally.

    Parameters

    • object: any

      Object to check for key.

    • key: string

      The key to check for on object.

    Returns boolean

    True if key is a property on object, otherwise false.

head

  • head<T>(array: List<T>): T
  • head<T>(array: List<T>, n: number): T[]
  • see

    _.first

    Type parameters

    • T

    Parameters

    Returns T

  • see

    _.first

    Type parameters

    • T

    Parameters

    • array: List<T>
    • n: number

    Returns T[]

identity

  • identity<T>(value: T): T

  • Returns the same value that is used as the argument. In math: f(x) = x This function looks useless, but is used throughout Underscore as a default iterator.

    Type parameters

    • T

    Parameters

    • value: T

      Identity of this object.

    Returns T

    value.

include

  • include<T>(list: Collection<T>, value: T): boolean
  • include<T>(object: Dictionary<T>, value: T): boolean
  • see

    _.contains

    Type parameters

    • T

    Parameters

    Returns boolean

  • see

    _.contains

    Type parameters

    • T

    Parameters

    Returns boolean

indexBy

  • Given a list, and an iterator function that returns a key for each element in the list (or a property name), returns an object with an index of each item. Just like _.groupBy, but for when you know your keys are unique.

    Type parameters

    • T

    Parameters

    Returns Dictionary<T>

  • see

    _.indexBy

    Type parameters

    • T

    Parameters

    • list: List<T>
    • iterator: string

      Property on each object to index them by.

    • Optional context: any

    Returns Dictionary<T>

indexOf

  • indexOf<T>(array: List<T>, value: T, isSorted?: boolean): number
  • indexOf<T>(array: List<T>, value: T, startFrom: number): number

  • Returns the index at which value can be found in the array, or -1 if value is not present in the array. Uses the native indexOf function unless it's missing. If you're working with a large array, and you know that the array is already sorted, pass true for isSorted to use a faster binary search ... or, pass a number as the third argument in order to look for the first matching value in the array after the given index.

    Type parameters

    • T

    Parameters

    • array: List<T>

      The array to search for the index of value.

    • value: T

      The value to search for within array.

    • Optional isSorted: boolean

      True if the array is already sorted, optional, default = false.

    Returns number

    The index of value within array.

  • see

    _indexof

    Type parameters

    • T

    Parameters

    • array: List<T>
    • value: T
    • startFrom: number

    Returns number

initial

  • initial<T>(array: List<T>, n?: number): T[]

  • Returns everything but the last entry of the array. Especially useful on the arguments object. Pass n to exclude the last n elements from the result.

    Type parameters

    • T

    Parameters

    • array: List<T>

      Retrieve all elements except the last n.

    • Optional n: number

      Leaves this many elements behind, optional.

    Returns T[]

    Returns everything but the last n elements of array.

inject

  • inject<T, TResult>(list: Collection<T>, iterator: MemoIterator<T, TResult>, memo?: TResult, context?: any): TResult
  • see

    _.reduce

    Type parameters

    • T

    • TResult

    Parameters

    Returns TResult

intersection

  • intersection<T>(...arrays: List<T>[]): T[]

  • Computes the list of values that are the intersection of all the arrays. Each value in the result is present in each of the arrays.

    Type parameters

    • T

    Parameters

    • Rest ...arrays: List<T>[]

      Array of arrays to compute the intersection of.

    Returns T[]

    The intersection of elements within arrays.

invert

  • invert(object: any): any

  • Returns a copy of the object where the keys have become the values and the values the keys. For this to work, all of your object's values should be unique and string serializable.

    Parameters

    • object: any

      Object to invert key/value pairs.

    Returns any

    An inverted key/value paired version of object.

invoke

  • invoke<T>(list: List<T>, methodName: string, ...arguments: any[]): any

  • Calls the method named by methodName on each value in the list. Any extra arguments passed to invoke will be forwarded on to the method invocation.

    Type parameters

    • T: object

    Parameters

    • list: List<T>

      The element's in this list will each have the method methodName invoked.

    • methodName: string

      The method's name to call on each element within list.

    • Rest ...arguments: any[]

      Additional arguments to pass to the method methodName.

    Returns any

isArguments

  • isArguments(object: any): boolean

  • Returns true if object is an Arguments object.

    Parameters

    • object: any

      Check if this object is an Arguments object.

    Returns boolean

    True if object is an Arguments object, otherwise false.

isArray

  • isArray(object: any): boolean
  • isArray<T>(object: any): boolean

  • Returns true if object is an Array.

    Parameters

    • object: any

      Check if this object is an Array.

    Returns boolean

    True if object is an Array, otherwise false.

  • Returns true if object is an Array.

    Type parameters

    • T

    Parameters

    • object: any

      Check if this object is an Array.

    Returns boolean

    True if object is an Array, otherwise false.

isBoolean

  • isBoolean(object: any): boolean

  • Returns true if object is either true or false.

    Parameters

    • object: any

      Check if this object is a bool.

    Returns boolean

    True if object is a bool, otherwise false.

isDate

  • isDate(object: any): boolean

  • Returns true if object is a Date.

    Parameters

    • object: any

      Check if this object is a Date.

    Returns boolean

    True if object is a Date, otherwise false.

isElement

  • isElement(object: any): boolean

  • Returns true if object is a DOM element.

    Parameters

    • object: any

      Check if this object is a DOM element.

    Returns boolean

    True if object is a DOM element, otherwise false.

isEmpty

  • isEmpty(object: any): boolean

  • Returns true if object contains no values.

    Parameters

    • object: any

      Check if this object has no properties or values.

    Returns boolean

    True if object is empty.

isEqual

  • isEqual(object: any, other: any): boolean

  • Performs an optimized deep comparison between the two objects, to determine if they should be considered equal.

    Parameters

    • object: any

      Compare to other.

    • other: any

      Compare to object.

    Returns boolean

    True if object is equal to other.

isError

  • isError(object: any): boolean

  • Returns true if object inherits from an Error.

    Parameters

    • object: any

      Check if this object is an Error.

    Returns boolean

    True if object is a Error, otherwise false.

isFinite

  • isFinite(object: any): boolean

  • Returns true if object is a finite Number.

    Parameters

    • object: any

      Check if this object is a finite Number.

    Returns boolean

    True if object is a finite Number.

isFunction

  • isFunction(object: any): boolean

  • Returns true if object is a Function.

    Parameters

    • object: any

      Check if this object is a Function.

    Returns boolean

    True if object is a Function, otherwise false.

isMatch

  • isMatch(object: any, properties: any): boolean

  • Returns true if the keys and values in properties matches with the object properties.

    Parameters

    • object: any

      Object to be compared with properties.

    • properties: any

      Properties be compared with object

    Returns boolean

    True if object has matching keys and values, otherwise false.

isNaN

  • isNaN(object: any): boolean

  • Returns true if object is NaN. Note: this is not the same as the native isNaN function, which will also return true if the variable is undefined.

    Parameters

    • object: any

      Check if this object is NaN.

    Returns boolean

    True if object is NaN, otherwise false.

isNull

  • isNull(object: any): boolean

  • Returns true if the value of object is null.

    Parameters

    • object: any

      Check if this object is null.

    Returns boolean

    True if object is null, otherwise false.

isNumber

  • isNumber(object: any): boolean

  • Returns true if object is a Number (including NaN).

    Parameters

    • object: any

      Check if this object is a Number.

    Returns boolean

    True if object is a Number, otherwise false.

isObject

  • isObject(object: any): boolean

  • Returns true if value is an Object. Note that JavaScript arrays and functions are objects, while (normal) strings and numbers are not.

    Parameters

    • object: any

      Check if this object is an Object.

    Returns boolean

    True of object is an Object, otherwise false.

isRegExp

  • isRegExp(object: any): boolean

  • Returns true if object is a RegExp.

    Parameters

    • object: any

      Check if this object is a RegExp.

    Returns boolean

    True if object is a RegExp, otherwise false.

isString

  • isString(object: any): boolean

  • Returns true if object is a String.

    Parameters

    • object: any

      Check if this object is a String.

    Returns boolean

    True if object is a String, otherwise false.

isUndefined

  • isUndefined(value: any): boolean

  • Returns true if value is undefined.

    Parameters

    • value: any

    Returns boolean

    True if object is undefined, otherwise false.

iteratee

  • iteratee(value: string): Function
  • iteratee(value: Function, context?: any, argCount?: number): Function
  • iteratee(value: Object): Function

  • A mostly-internal function to generate callbacks that can be applied to each element in a collection, returning the desired result -- either identity, an arbitrary callback, a property matcher, or a propetery accessor.

    Parameters

    • value: string

    Returns Function

    Callback that can be applied to each element in a collection.

  • Parameters

    • value: Function
    • Optional context: any
    • Optional argCount: number

    Returns Function

  • Parameters

    • value: Object

    Returns Function

keys

  • keys(object: any): string[]

  • Retrieve all the names of the object's properties.

    Parameters

    • object: any

      Retrieve the key or property names from this object.

    Returns string[]

    List of all the property names on object.

last

  • last<T>(array: List<T>): T
  • last<T>(array: List<T>, n: number): T[]

  • Returns the last element of an array. Passing n will return the last n elements of the array.

    Type parameters

    • T

    Parameters

    • array: List<T>

      Retrieves the last element of this array.

    Returns T

    Returns the last element of array.

  • see

    _.last

    Type parameters

    • T

    Parameters

    • array: List<T>
    • n: number

      Return more than one element from array.

    Returns T[]

lastIndexOf

  • lastIndexOf<T>(array: List<T>, value: T, from?: number): number

  • Returns the index of the last occurrence of value in the array, or -1 if value is not present. Uses the native lastIndexOf function if possible. Pass fromIndex to start your search at a given index.

    Type parameters

    • T

    Parameters

    • array: List<T>

      The array to search for the last index of value.

    • value: T

      The value to search for within array.

    • Optional from: number

      The starting index for the search, optional.

    Returns number

    The index of the last occurrence of value within array.

map

  • Produces a new array of values by mapping each value in list through a transformation function (iterator). If the native map method exists, it will be used instead. If list is a JavaScript object, iterator's arguments will be (value, key, object).

    Type parameters

    • T

    • TResult

    Parameters

    • list: List<T>

      Maps the elements of this array.

    • iterator: ListIterator<T, TResult>

      Map iterator function for each element in list.

    • Optional context: any

      this object in iterator, optional.

    Returns TResult[]

    The mapped array result.

  • see

    _.map

    Type parameters

    • T

    • TResult

    Parameters

    • object: Dictionary<T>

      Maps the properties of this object.

    • iterator: ObjectIterator<T, TResult>

      Map iterator function for each property on object.

    • Optional context: any

      this object in iterator, optional.

    Returns TResult[]

    The mapped object result.

mapObject

  • mapObject<T, U>(object: Dictionary<T>, iteratee: function, context?: any): Dictionary<U>
  • mapObject<T>(object: any, iteratee: function, context?: any): Dictionary<T>
  • mapObject(object: any, iteratee: string, context?: any): Dictionary<any>

  • Like map, but for objects. Transform the value of each property in turn.

    Type parameters

    • T

    • U

    Parameters

    • object: Dictionary<T>

      The object to transform

    • iteratee: function

      The function that transforms property values

        • Parameters

          Returns U

    • Optional context: any

      The optional context (value of this) to bind to

    Returns Dictionary<U>

    a new _.Dictionary of property values

  • Like map, but for objects. Transform the value of each property in turn.

    Type parameters

    • T

    Parameters

    • object: any

      The object to transform

    • iteratee: function

      The function that tranforms property values

        • (val: any, key: string, object: any): T

        • Parameters

          • val: any
          • key: string
          • object: any

          Returns T

    • Optional context: any

      The optional context (value of this) to bind to

    Returns Dictionary<T>

  • Like map, but for objects. Retrieves a property from each entry in the object, as if by _.property

    Parameters

    • object: any

      The object to transform

    • iteratee: string

      The property name to retrieve

    • Optional context: any

      The optional context (value of this) to bind to

    Returns Dictionary<any>

matches

  • Returns a predicate function that will tell you if a passed in object contains all of the key/value properties present in attrs.

    Type parameters

    • T

    • TResult

    Parameters

    • attrs: T

      Object with key values pair

    Returns ListIterator<T, TResult>

    Predicate function

max

  • max(list: List<number>): number
  • max<T>(list: List<T>, iterator?: ListIterator<T, any>, context?: any): T

  • Returns the maximum value in list.

    Parameters

    • list: List<number>

      Finds the maximum value in this list.

    Returns number

    Maximum value in list.

  • Returns the maximum value in list. If iterator is passed, it will be used on each value to generate the criterion by which the value is ranked.

    Type parameters

    • T

    Parameters

    • list: List<T>

      Finds the maximum value in this list.

    • Optional iterator: ListIterator<T, any>

      Compares each element in list to find the maximum value.

    • Optional context: any

      this object in iterator, optional.

    Returns T

    The maximum element within list.

memoize

  • memoize(fn: Function, hashFn?: function): Function

  • Memoizes a given function by caching the computed result. Useful for speeding up slow-running computations. If passed an optional hashFunction, it will be used to compute the hash key for storing the result, based on the arguments to the original function. The default hashFunction just uses the first argument to the memoized function as the key.

    Parameters

    • fn: Function

      Computationally expensive function that will now memoized results.

    • Optional hashFn: function

      Hash function for storing the result of fn.

        • (...args: any[]): string

        • Parameters

          • Rest ...args: any[]

          Returns string

    Returns Function

    Memoized version of fn.

methods

  • methods(object: any): string[]
  • see

    _functions

    Parameters

    • object: any

    Returns string[]

min

  • min(list: List<number>): number
  • min<T>(list: List<T>, iterator?: ListIterator<T, any>, context?: any): T

  • Returns the minimum value in list.

    Parameters

    • list: List<number>

      Finds the minimum value in this list.

    Returns number

    Minimum value in list.

  • Returns the minimum value in list. If iterator is passed, it will be used on each value to generate the criterion by which the value is ranked.

    Type parameters

    • T

    Parameters

    • list: List<T>

      Finds the minimum value in this list.

    • Optional iterator: ListIterator<T, any>

      Compares each element in list to find the minimum value.

    • Optional context: any

      this object in iterator, optional.

    Returns T

    The minimum element within list.

mixin

  • mixin(object: any): void

  • Allows you to extend Underscore with your own utility functions. Pass a hash of {name: function} definitions to have your functions added to the Underscore object, as well as the OOP wrapper.

    Parameters

    • object: any

      Mixin object containing key/function pairs to add to the Underscore object.

    Returns void

negate

  • negate(predicate: Function): boolean

  • Returns a negated version of the pass-in predicate.

    Parameters

    • predicate: Function

    Returns boolean

    boolean

noConflict

  • noConflict(): any

  • Give control of the "_" variable back to its previous owner. Returns a reference to the Underscore object.

    Returns any

    Underscore object reference.

noop

  • noop(): void

  • Returns undefined irrespective of the arguments passed to it. Useful as the default for optional callback arguments. Note there is no way to indicate a 'undefined' return, so it is currently typed as void.

    Returns void

    undefined

now

  • now(): number

  • Returns an integer timestamp for the current time, using the fastest method available in the runtime. Useful for implementing timing/animation functions.

    Returns number

object

  • object<TResult>(keys: List<string>, values: List<any>): TResult
  • object<TResult>(...keyValuePairs: any[]): TResult
  • object<TResult>(list: List<any>, values?: any): TResult

  • Converts arrays into objects. Pass either a single list of [key, value] pairs, or a list of keys, and a list of values.

    Type parameters

    • TResult: object

    Parameters

    • keys: List<string>

      Key array.

    • values: List<any>

      Value array.

    Returns TResult

    An object containing the keys as properties and values as the property values.

  • Converts arrays into objects. Pass either a single list of [key, value] pairs, or a list of keys, and a list of values.

    Type parameters

    • TResult: object

    Parameters

    • Rest ...keyValuePairs: any[]

      Array of [key, value] pairs.

    Returns TResult

    An object containing the keys as properties and values as the property values.

  • see

    _.object

    Type parameters

    • TResult: object

    Parameters

    • list: List<any>
    • Optional values: any

    Returns TResult

omit

  • omit(object: any, ...keys: string[]): any
  • omit(object: any, keys: string[]): any
  • omit(object: any, iteratee: Function): any

  • Return a copy of the object, filtered to omit the blacklisted keys (or array of keys).

    Parameters

    • object: any

      Object to strip unwanted key/value pairs.

    • Rest ...keys: string[]

      The key/value pairs to remove on object.

    Returns any

    Copy of object without the keys properties.

  • see

    _.omit

    Parameters

    • object: any
    • keys: string[]

    Returns any

  • see

    _.omit

    Parameters

    • object: any
    • iteratee: Function

    Returns any

once

  • once<T>(fn: T): T

  • Creates a version of the function that can only be called one time. Repeated calls to the modified function will have no effect, returning the value from the original call. Useful for initialization functions, instead of having to set a boolean flag and then check it later.

    Type parameters

    • T: Function

    Parameters

    • fn: T

      Function to only execute once.

    Returns T

    Copy of fn that can only be invoked once.

pairs

  • pairs(object: any): any[]

  • Convert an object into a list of [key, value] pairs.

    Parameters

    • object: any

      Convert this object to a list of [key, value] pairs.

    Returns any[]

    List of [key, value] pairs on object.

partial

  • Partially apply a function by filling in any number of its arguments, without changing its dynamic this value. A close cousin of bind. You may pass _ in your list of arguments to specify an argument that should not be pre-filled, but left open to supply at call-time.

    Type parameters

    • T1

    • T2

    Parameters

    • fn: function

      Function to partially fill in arguments.

        • (p1: T1): T2

        • Parameters

          • p1: T1

          Returns T2

    • p1: T1

    Returns function

    fn with partially filled in arguments.

      • (): T2

      • Returns T2

  • Type parameters

    • T1

    • T2

    • T3

    Parameters

    • fn: function
        • (p1: T1, p2: T2): T3

        • Parameters

          • p1: T1
          • p2: T2

          Returns T3

    • p1: T1

    Returns function

      • (p2: T2): T3

      • Parameters

        • p2: T2

        Returns T3

  • Type parameters

    • T1

    • T2

    • T3

    Parameters

    • fn: function
        • (p1: T1, p2: T2): T3

        • Parameters

          • p1: T1
          • p2: T2

          Returns T3

    • p1: T1
    • p2: T2

    Returns function

      • (): T3

      • Returns T3

  • Type parameters

    • T1

    • T2

    • T3

    Parameters

    • fn: function
        • (p1: T1, p2: T2): T3

        • Parameters

          • p1: T1
          • p2: T2

          Returns T3

    • stub1: UnderscoreStatic
    • p2: T2

    Returns function

      • (p1: T1): T3

      • Parameters

        • p1: T1

        Returns T3

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3): T4

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3

          Returns T4

    • p1: T1

    Returns function

      • (p2: T2, p3: T3): T4

      • Parameters

        • p2: T2
        • p3: T3

        Returns T4

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3): T4

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3

          Returns T4

    • p1: T1
    • p2: T2

    Returns function

      • (p3: T3): T4

      • Parameters

        • p3: T3

        Returns T4

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3): T4

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3

          Returns T4

    • stub1: UnderscoreStatic
    • p2: T2

    Returns function

      • (p1: T1, p3: T3): T4

      • Parameters

        • p1: T1
        • p3: T3

        Returns T4

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3): T4

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3

          Returns T4

    • p1: T1
    • p2: T2
    • p3: T3

    Returns function

      • (): T4

      • Returns T4

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3): T4

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3

          Returns T4

    • stub1: UnderscoreStatic
    • p2: T2
    • p3: T3

    Returns function

      • (p1: T1): T4

      • Parameters

        • p1: T1

        Returns T4

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3): T4

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3

          Returns T4

    • p1: T1
    • stub2: UnderscoreStatic
    • p3: T3

    Returns function

      • (p2: T2): T4

      • Parameters

        • p2: T2

        Returns T4

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    Parameters

    Returns function

      • (p1: T1, p2: T2): T4

      • Parameters

        • p1: T1
        • p2: T2

        Returns T4

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4): T5

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4

          Returns T5

    • p1: T1

    Returns function

      • (p2: T2, p3: T3, p4: T4): T5

      • Parameters

        • p2: T2
        • p3: T3
        • p4: T4

        Returns T5

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4): T5

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4

          Returns T5

    • p1: T1
    • p2: T2

    Returns function

      • (p3: T3, p4: T4): T5

      • Parameters

        • p3: T3
        • p4: T4

        Returns T5

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4): T5

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4

          Returns T5

    • stub1: UnderscoreStatic
    • p2: T2

    Returns function

      • (p1: T1, p3: T3, p4: T4): T5

      • Parameters

        • p1: T1
        • p3: T3
        • p4: T4

        Returns T5

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4): T5

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4

          Returns T5

    • p1: T1
    • p2: T2
    • p3: T3

    Returns function

      • (p4: T4): T5

      • Parameters

        • p4: T4

        Returns T5

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4): T5

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4

          Returns T5

    • stub1: UnderscoreStatic
    • p2: T2
    • p3: T3

    Returns function

      • (p1: T1, p4: T4): T5

      • Parameters

        • p1: T1
        • p4: T4

        Returns T5

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4): T5

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4

          Returns T5

    • p1: T1
    • stub2: UnderscoreStatic
    • p3: T3

    Returns function

      • (p2: T2, p4: T4): T5

      • Parameters

        • p2: T2
        • p4: T4

        Returns T5

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    Parameters

    Returns function

      • (p1: T1, p2: T2, p4: T4): T5

      • Parameters

        • p1: T1
        • p2: T2
        • p4: T4

        Returns T5

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4): T5

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4

          Returns T5

    • p1: T1
    • p2: T2
    • p3: T3
    • p4: T4

    Returns function

      • (): T5

      • Returns T5

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4): T5

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4

          Returns T5

    • stub1: UnderscoreStatic
    • p2: T2
    • p3: T3
    • p4: T4

    Returns function

      • (p1: T1): T5

      • Parameters

        • p1: T1

        Returns T5

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4): T5

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4

          Returns T5

    • p1: T1
    • stub2: UnderscoreStatic
    • p3: T3
    • p4: T4

    Returns function

      • (p2: T2): T5

      • Parameters

        • p2: T2

        Returns T5

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4): T5

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4

          Returns T5

    • stub1: UnderscoreStatic
    • stub2: UnderscoreStatic
    • p3: T3
    • p4: T4

    Returns function

      • (p1: T1, p2: T2): T5

      • Parameters

        • p1: T1
        • p2: T2

        Returns T5

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4): T5

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4

          Returns T5

    • p1: T1
    • p2: T2
    • stub3: UnderscoreStatic
    • p4: T4

    Returns function

      • (p3: T3): T5

      • Parameters

        • p3: T3

        Returns T5

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4): T5

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4

          Returns T5

    • stub1: UnderscoreStatic
    • p2: T2
    • stub3: UnderscoreStatic
    • p4: T4

    Returns function

      • (p1: T1, p3: T3): T5

      • Parameters

        • p1: T1
        • p3: T3

        Returns T5

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4): T5

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4

          Returns T5

    • p1: T1
    • stub2: UnderscoreStatic
    • stub3: UnderscoreStatic
    • p4: T4

    Returns function

      • (p2: T2, p3: T3): T5

      • Parameters

        • p2: T2
        • p3: T3

        Returns T5

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    Parameters

    Returns function

      • (p1: T1, p2: T2, p3: T3): T5

      • Parameters

        • p1: T1
        • p2: T2
        • p3: T3

        Returns T5

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5): T6

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5

          Returns T6

    • p1: T1

    Returns function

      • (p2: T2, p3: T3, p4: T4, p5: T5): T6

      • Parameters

        • p2: T2
        • p3: T3
        • p4: T4
        • p5: T5

        Returns T6

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5): T6

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5

          Returns T6

    • p1: T1
    • p2: T2

    Returns function

      • (p3: T3, p4: T4, p5: T5): T6

      • Parameters

        • p3: T3
        • p4: T4
        • p5: T5

        Returns T6

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5): T6

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5

          Returns T6

    • stub1: UnderscoreStatic
    • p2: T2

    Returns function

      • (p1: T1, p3: T3, p4: T4, p5: T5): T6

      • Parameters

        • p1: T1
        • p3: T3
        • p4: T4
        • p5: T5

        Returns T6

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5): T6

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5

          Returns T6

    • p1: T1
    • p2: T2
    • p3: T3

    Returns function

      • (p4: T4, p5: T5): T6

      • Parameters

        • p4: T4
        • p5: T5

        Returns T6

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5): T6

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5

          Returns T6

    • stub1: UnderscoreStatic
    • p2: T2
    • p3: T3

    Returns function

      • (p1: T1, p4: T4, p5: T5): T6

      • Parameters

        • p1: T1
        • p4: T4
        • p5: T5

        Returns T6

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5): T6

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5

          Returns T6

    • p1: T1
    • stub2: UnderscoreStatic
    • p3: T3

    Returns function

      • (p2: T2, p4: T4, p5: T5): T6

      • Parameters

        • p2: T2
        • p4: T4
        • p5: T5

        Returns T6

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5): T6

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5

          Returns T6

    • stub1: UnderscoreStatic
    • stub2: UnderscoreStatic
    • p3: T3

    Returns function

      • (p1: T1, p2: T2, p4: T4, p5: T5): T6

      • Parameters

        • p1: T1
        • p2: T2
        • p4: T4
        • p5: T5

        Returns T6

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5): T6

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5

          Returns T6

    • p1: T1
    • p2: T2
    • p3: T3
    • p4: T4

    Returns function

      • (p5: T5): T6

      • Parameters

        • p5: T5

        Returns T6

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5): T6

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5

          Returns T6

    • stub1: UnderscoreStatic
    • p2: T2
    • p3: T3
    • p4: T4

    Returns function

      • (p1: T1, p5: T5): T6

      • Parameters

        • p1: T1
        • p5: T5

        Returns T6

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5): T6

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5

          Returns T6

    • p1: T1
    • stub2: UnderscoreStatic
    • p3: T3
    • p4: T4

    Returns function

      • (p2: T2, p5: T5): T6

      • Parameters

        • p2: T2
        • p5: T5

        Returns T6

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5): T6

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5

          Returns T6

    • stub1: UnderscoreStatic
    • stub2: UnderscoreStatic
    • p3: T3
    • p4: T4

    Returns function

      • (p1: T1, p2: T2, p5: T5): T6

      • Parameters

        • p1: T1
        • p2: T2
        • p5: T5

        Returns T6

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5): T6

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5

          Returns T6

    • p1: T1
    • p2: T2
    • stub3: UnderscoreStatic
    • p4: T4

    Returns function

      • (p3: T3, p5: T5): T6

      • Parameters

        • p3: T3
        • p5: T5

        Returns T6

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5): T6

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5

          Returns T6

    • stub1: UnderscoreStatic
    • p2: T2
    • stub3: UnderscoreStatic
    • p4: T4

    Returns function

      • (p1: T1, p3: T3, p5: T5): T6

      • Parameters

        • p1: T1
        • p3: T3
        • p5: T5

        Returns T6

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5): T6

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5

          Returns T6

    • p1: T1
    • stub2: UnderscoreStatic
    • stub3: UnderscoreStatic
    • p4: T4

    Returns function

      • (p2: T2, p3: T3, p5: T5): T6

      • Parameters

        • p2: T2
        • p3: T3
        • p5: T5

        Returns T6

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    Parameters

    Returns function

      • (p1: T1, p2: T2, p3: T3, p5: T5): T6

      • Parameters

        • p1: T1
        • p2: T2
        • p3: T3
        • p5: T5

        Returns T6

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5): T6

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5

          Returns T6

    • p1: T1
    • p2: T2
    • p3: T3
    • p4: T4
    • p5: T5

    Returns function

      • (): T6

      • Returns T6

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5): T6

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5

          Returns T6

    • stub1: UnderscoreStatic
    • p2: T2
    • p3: T3
    • p4: T4
    • p5: T5

    Returns function

      • (p1: T1): T6

      • Parameters

        • p1: T1

        Returns T6

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5): T6

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5

          Returns T6

    • p1: T1
    • stub2: UnderscoreStatic
    • p3: T3
    • p4: T4
    • p5: T5

    Returns function

      • (p2: T2): T6

      • Parameters

        • p2: T2

        Returns T6

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5): T6

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5

          Returns T6

    • stub1: UnderscoreStatic
    • stub2: UnderscoreStatic
    • p3: T3
    • p4: T4
    • p5: T5

    Returns function

      • (p1: T1, p2: T2): T6

      • Parameters

        • p1: T1
        • p2: T2

        Returns T6

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5): T6

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5

          Returns T6

    • p1: T1
    • p2: T2
    • stub3: UnderscoreStatic
    • p4: T4
    • p5: T5

    Returns function

      • (p3: T3): T6

      • Parameters

        • p3: T3

        Returns T6

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5): T6

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5

          Returns T6

    • stub1: UnderscoreStatic
    • p2: T2
    • stub3: UnderscoreStatic
    • p4: T4
    • p5: T5

    Returns function

      • (p1: T1, p3: T3): T6

      • Parameters

        • p1: T1
        • p3: T3

        Returns T6

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5): T6

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5

          Returns T6

    • p1: T1
    • stub2: UnderscoreStatic
    • stub3: UnderscoreStatic
    • p4: T4
    • p5: T5

    Returns function

      • (p2: T2, p3: T3): T6

      • Parameters

        • p2: T2
        • p3: T3

        Returns T6

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    Parameters

    Returns function

      • (p1: T1, p2: T2, p3: T3): T6

      • Parameters

        • p1: T1
        • p2: T2
        • p3: T3

        Returns T6

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5): T6

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5

          Returns T6

    • p1: T1
    • p2: T2
    • p3: T3
    • stub4: UnderscoreStatic
    • p5: T5

    Returns function

      • (p4: T4): T6

      • Parameters

        • p4: T4

        Returns T6

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5): T6

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5

          Returns T6

    • stub1: UnderscoreStatic
    • p2: T2
    • p3: T3
    • stub4: UnderscoreStatic
    • p5: T5

    Returns function

      • (p1: T1, p4: T4): T6

      • Parameters

        • p1: T1
        • p4: T4

        Returns T6

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5): T6

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5

          Returns T6

    • p1: T1
    • stub2: UnderscoreStatic
    • p3: T3
    • stub4: UnderscoreStatic
    • p5: T5

    Returns function

      • (p2: T2, p4: T4): T6

      • Parameters

        • p2: T2
        • p4: T4

        Returns T6

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    Parameters

    Returns function

      • (p1: T1, p2: T2, p4: T4): T6

      • Parameters

        • p1: T1
        • p2: T2
        • p4: T4

        Returns T6

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5): T6

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5

          Returns T6

    • p1: T1
    • p2: T2
    • stub3: UnderscoreStatic
    • stub4: UnderscoreStatic
    • p5: T5

    Returns function

      • (p3: T3, p4: T4): T6

      • Parameters

        • p3: T3
        • p4: T4

        Returns T6

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    Parameters

    Returns function

      • (p1: T1, p3: T3, p4: T4): T6

      • Parameters

        • p1: T1
        • p3: T3
        • p4: T4

        Returns T6

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    Parameters

    Returns function

      • (p2: T2, p3: T3, p4: T4): T6

      • Parameters

        • p2: T2
        • p3: T3
        • p4: T4

        Returns T6

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    Parameters

    Returns function

      • (p1: T1, p2: T2, p3: T3, p4: T4): T6

      • Parameters

        • p1: T1
        • p2: T2
        • p3: T3
        • p4: T4

        Returns T6

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5, p6: T6): T7

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5
          • p6: T6

          Returns T7

    • p1: T1

    Returns function

      • (p2: T2, p3: T3, p4: T4, p5: T5, p6: T6): T7

      • Parameters

        • p2: T2
        • p3: T3
        • p4: T4
        • p5: T5
        • p6: T6

        Returns T7

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5, p6: T6): T7

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5
          • p6: T6

          Returns T7

    • p1: T1
    • p2: T2

    Returns function

      • (p3: T3, p4: T4, p5: T5, p6: T6): T7

      • Parameters

        • p3: T3
        • p4: T4
        • p5: T5
        • p6: T6

        Returns T7

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5, p6: T6): T7

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5
          • p6: T6

          Returns T7

    • stub1: UnderscoreStatic
    • p2: T2

    Returns function

      • (p1: T1, p3: T3, p4: T4, p5: T5, p6: T6): T7

      • Parameters

        • p1: T1
        • p3: T3
        • p4: T4
        • p5: T5
        • p6: T6

        Returns T7

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5, p6: T6): T7

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5
          • p6: T6

          Returns T7

    • p1: T1
    • p2: T2
    • p3: T3

    Returns function

      • (p4: T4, p5: T5, p6: T6): T7

      • Parameters

        • p4: T4
        • p5: T5
        • p6: T6

        Returns T7

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5, p6: T6): T7

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5
          • p6: T6

          Returns T7

    • stub1: UnderscoreStatic
    • p2: T2
    • p3: T3

    Returns function

      • (p1: T1, p4: T4, p5: T5, p6: T6): T7

      • Parameters

        • p1: T1
        • p4: T4
        • p5: T5
        • p6: T6

        Returns T7

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5, p6: T6): T7

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5
          • p6: T6

          Returns T7

    • p1: T1
    • stub2: UnderscoreStatic
    • p3: T3

    Returns function

      • (p2: T2, p4: T4, p5: T5, p6: T6): T7

      • Parameters

        • p2: T2
        • p4: T4
        • p5: T5
        • p6: T6

        Returns T7

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5, p6: T6): T7

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5
          • p6: T6

          Returns T7

    • stub1: UnderscoreStatic
    • stub2: UnderscoreStatic
    • p3: T3

    Returns function

      • (p1: T1, p2: T2, p4: T4, p5: T5, p6: T6): T7

      • Parameters

        • p1: T1
        • p2: T2
        • p4: T4
        • p5: T5
        • p6: T6

        Returns T7

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5, p6: T6): T7

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5
          • p6: T6

          Returns T7

    • p1: T1
    • p2: T2
    • p3: T3
    • p4: T4

    Returns function

      • (p5: T5, p6: T6): T7

      • Parameters

        • p5: T5
        • p6: T6

        Returns T7

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5, p6: T6): T7

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5
          • p6: T6

          Returns T7

    • stub1: UnderscoreStatic
    • p2: T2
    • p3: T3
    • p4: T4

    Returns function

      • (p1: T1, p5: T5, p6: T6): T7

      • Parameters

        • p1: T1
        • p5: T5
        • p6: T6

        Returns T7

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5, p6: T6): T7

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5
          • p6: T6

          Returns T7

    • p1: T1
    • stub2: UnderscoreStatic
    • p3: T3
    • p4: T4

    Returns function

      • (p2: T2, p5: T5, p6: T6): T7

      • Parameters

        • p2: T2
        • p5: T5
        • p6: T6

        Returns T7

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5, p6: T6): T7

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5
          • p6: T6

          Returns T7

    • stub1: UnderscoreStatic
    • stub2: UnderscoreStatic
    • p3: T3
    • p4: T4

    Returns function

      • (p1: T1, p2: T2, p5: T5, p6: T6): T7

      • Parameters

        • p1: T1
        • p2: T2
        • p5: T5
        • p6: T6

        Returns T7

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5, p6: T6): T7

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5
          • p6: T6

          Returns T7

    • p1: T1
    • p2: T2
    • stub3: UnderscoreStatic
    • p4: T4

    Returns function

      • (p3: T3, p5: T5, p6: T6): T7

      • Parameters

        • p3: T3
        • p5: T5
        • p6: T6

        Returns T7

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5, p6: T6): T7

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5
          • p6: T6

          Returns T7

    • stub1: UnderscoreStatic
    • p2: T2
    • stub3: UnderscoreStatic
    • p4: T4

    Returns function

      • (p1: T1, p3: T3, p5: T5, p6: T6): T7

      • Parameters

        • p1: T1
        • p3: T3
        • p5: T5
        • p6: T6

        Returns T7

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5, p6: T6): T7

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5
          • p6: T6

          Returns T7

    • p1: T1
    • stub2: UnderscoreStatic
    • stub3: UnderscoreStatic
    • p4: T4

    Returns function

      • (p2: T2, p3: T3, p5: T5, p6: T6): T7

      • Parameters

        • p2: T2
        • p3: T3
        • p5: T5
        • p6: T6

        Returns T7

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    Parameters

    Returns function

      • (p1: T1, p2: T2, p3: T3, p5: T5, p6: T6): T7

      • Parameters

        • p1: T1
        • p2: T2
        • p3: T3
        • p5: T5
        • p6: T6

        Returns T7

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5, p6: T6): T7

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5
          • p6: T6

          Returns T7

    • p1: T1
    • p2: T2
    • p3: T3
    • p4: T4
    • p5: T5

    Returns function

      • (p6: T6): T7

      • Parameters

        • p6: T6

        Returns T7

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5, p6: T6): T7

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5
          • p6: T6

          Returns T7

    • stub1: UnderscoreStatic
    • p2: T2
    • p3: T3
    • p4: T4
    • p5: T5

    Returns function

      • (p1: T1, p6: T6): T7

      • Parameters

        • p1: T1
        • p6: T6

        Returns T7

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5, p6: T6): T7

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5
          • p6: T6

          Returns T7

    • p1: T1
    • stub2: UnderscoreStatic
    • p3: T3
    • p4: T4
    • p5: T5

    Returns function

      • (p2: T2, p6: T6): T7

      • Parameters

        • p2: T2
        • p6: T6

        Returns T7

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5, p6: T6): T7

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5
          • p6: T6

          Returns T7

    • stub1: UnderscoreStatic
    • stub2: UnderscoreStatic
    • p3: T3
    • p4: T4
    • p5: T5

    Returns function

      • (p1: T1, p2: T2, p6: T6): T7

      • Parameters

        • p1: T1
        • p2: T2
        • p6: T6

        Returns T7

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5, p6: T6): T7

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5
          • p6: T6

          Returns T7

    • p1: T1
    • p2: T2
    • stub3: UnderscoreStatic
    • p4: T4
    • p5: T5

    Returns function

      • (p3: T3, p6: T6): T7

      • Parameters

        • p3: T3
        • p6: T6

        Returns T7

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5, p6: T6): T7

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5
          • p6: T6

          Returns T7

    • stub1: UnderscoreStatic
    • p2: T2
    • stub3: UnderscoreStatic
    • p4: T4
    • p5: T5

    Returns function

      • (p1: T1, p3: T3, p6: T6): T7

      • Parameters

        • p1: T1
        • p3: T3
        • p6: T6

        Returns T7

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5, p6: T6): T7

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5
          • p6: T6

          Returns T7

    • p1: T1
    • stub2: UnderscoreStatic
    • stub3: UnderscoreStatic
    • p4: T4
    • p5: T5

    Returns function

      • (p2: T2, p3: T3, p6: T6): T7

      • Parameters

        • p2: T2
        • p3: T3
        • p6: T6

        Returns T7

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    Parameters

    Returns function

      • (p1: T1, p2: T2, p3: T3, p6: T6): T7

      • Parameters

        • p1: T1
        • p2: T2
        • p3: T3
        • p6: T6

        Returns T7

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5, p6: T6): T7

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5
          • p6: T6

          Returns T7

    • p1: T1
    • p2: T2
    • p3: T3
    • stub4: UnderscoreStatic
    • p5: T5

    Returns function

      • (p4: T4, p6: T6): T7

      • Parameters

        • p4: T4
        • p6: T6

        Returns T7

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5, p6: T6): T7

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5
          • p6: T6

          Returns T7

    • stub1: UnderscoreStatic
    • p2: T2
    • p3: T3
    • stub4: UnderscoreStatic
    • p5: T5

    Returns function

      • (p1: T1, p4: T4, p6: T6): T7

      • Parameters

        • p1: T1
        • p4: T4
        • p6: T6

        Returns T7

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5, p6: T6): T7

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5
          • p6: T6

          Returns T7

    • p1: T1
    • stub2: UnderscoreStatic
    • p3: T3
    • stub4: UnderscoreStatic
    • p5: T5

    Returns function

      • (p2: T2, p4: T4, p6: T6): T7

      • Parameters

        • p2: T2
        • p4: T4
        • p6: T6

        Returns T7

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    Parameters

    Returns function

      • (p1: T1, p2: T2, p4: T4, p6: T6): T7

      • Parameters

        • p1: T1
        • p2: T2
        • p4: T4
        • p6: T6

        Returns T7

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5, p6: T6): T7

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5
          • p6: T6

          Returns T7

    • p1: T1
    • p2: T2
    • stub3: UnderscoreStatic
    • stub4: UnderscoreStatic
    • p5: T5

    Returns function

      • (p3: T3, p4: T4, p6: T6): T7

      • Parameters

        • p3: T3
        • p4: T4
        • p6: T6

        Returns T7

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    Parameters

    Returns function

      • (p1: T1, p3: T3, p4: T4, p6: T6): T7

      • Parameters

        • p1: T1
        • p3: T3
        • p4: T4
        • p6: T6

        Returns T7

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    Parameters

    Returns function

      • (p2: T2, p3: T3, p4: T4, p6: T6): T7

      • Parameters

        • p2: T2
        • p3: T3
        • p4: T4
        • p6: T6

        Returns T7

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    Parameters

    Returns function

      • (p1: T1, p2: T2, p3: T3, p4: T4, p6: T6): T7

      • Parameters

        • p1: T1
        • p2: T2
        • p3: T3
        • p4: T4
        • p6: T6

        Returns T7

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5, p6: T6): T7

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5
          • p6: T6

          Returns T7

    • p1: T1
    • p2: T2
    • p3: T3
    • p4: T4
    • p5: T5
    • p6: T6

    Returns function

      • (): T7

      • Returns T7

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5, p6: T6): T7

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5
          • p6: T6

          Returns T7

    • stub1: UnderscoreStatic
    • p2: T2
    • p3: T3
    • p4: T4
    • p5: T5
    • p6: T6

    Returns function

      • (p1: T1): T7

      • Parameters

        • p1: T1

        Returns T7

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5, p6: T6): T7

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5
          • p6: T6

          Returns T7

    • p1: T1
    • stub2: UnderscoreStatic
    • p3: T3
    • p4: T4
    • p5: T5
    • p6: T6

    Returns function

      • (p2: T2): T7

      • Parameters

        • p2: T2

        Returns T7

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5, p6: T6): T7

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5
          • p6: T6

          Returns T7

    • stub1: UnderscoreStatic
    • stub2: UnderscoreStatic
    • p3: T3
    • p4: T4
    • p5: T5
    • p6: T6

    Returns function

      • (p1: T1, p2: T2): T7

      • Parameters

        • p1: T1
        • p2: T2

        Returns T7

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5, p6: T6): T7

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5
          • p6: T6

          Returns T7

    • p1: T1
    • p2: T2
    • stub3: UnderscoreStatic
    • p4: T4
    • p5: T5
    • p6: T6

    Returns function

      • (p3: T3): T7

      • Parameters

        • p3: T3

        Returns T7

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5, p6: T6): T7

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5
          • p6: T6

          Returns T7

    • stub1: UnderscoreStatic
    • p2: T2
    • stub3: UnderscoreStatic
    • p4: T4
    • p5: T5
    • p6: T6

    Returns function

      • (p1: T1, p3: T3): T7

      • Parameters

        • p1: T1
        • p3: T3

        Returns T7

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5, p6: T6): T7

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5
          • p6: T6

          Returns T7

    • p1: T1
    • stub2: UnderscoreStatic
    • stub3: UnderscoreStatic
    • p4: T4
    • p5: T5
    • p6: T6

    Returns function

      • (p2: T2, p3: T3): T7

      • Parameters

        • p2: T2
        • p3: T3

        Returns T7

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    Parameters

    Returns function

      • (p1: T1, p2: T2, p3: T3): T7

      • Parameters

        • p1: T1
        • p2: T2
        • p3: T3

        Returns T7

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5, p6: T6): T7

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5
          • p6: T6

          Returns T7

    • p1: T1
    • p2: T2
    • p3: T3
    • stub4: UnderscoreStatic
    • p5: T5
    • p6: T6

    Returns function

      • (p4: T4): T7

      • Parameters

        • p4: T4

        Returns T7

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5, p6: T6): T7

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5
          • p6: T6

          Returns T7

    • stub1: UnderscoreStatic
    • p2: T2
    • p3: T3
    • stub4: UnderscoreStatic
    • p5: T5
    • p6: T6

    Returns function

      • (p1: T1, p4: T4): T7

      • Parameters

        • p1: T1
        • p4: T4

        Returns T7

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5, p6: T6): T7

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5
          • p6: T6

          Returns T7

    • p1: T1
    • stub2: UnderscoreStatic
    • p3: T3
    • stub4: UnderscoreStatic
    • p5: T5
    • p6: T6

    Returns function

      • (p2: T2, p4: T4): T7

      • Parameters

        • p2: T2
        • p4: T4

        Returns T7

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    Parameters

    Returns function

      • (p1: T1, p2: T2, p4: T4): T7

      • Parameters

        • p1: T1
        • p2: T2
        • p4: T4

        Returns T7

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5, p6: T6): T7

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5
          • p6: T6

          Returns T7

    • p1: T1
    • p2: T2
    • stub3: UnderscoreStatic
    • stub4: UnderscoreStatic
    • p5: T5
    • p6: T6

    Returns function

      • (p3: T3, p4: T4): T7

      • Parameters

        • p3: T3
        • p4: T4

        Returns T7

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    Parameters

    Returns function

      • (p1: T1, p3: T3, p4: T4): T7

      • Parameters

        • p1: T1
        • p3: T3
        • p4: T4

        Returns T7

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    Parameters

    Returns function

      • (p2: T2, p3: T3, p4: T4): T7

      • Parameters

        • p2: T2
        • p3: T3
        • p4: T4

        Returns T7

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    Parameters

    Returns function

      • (p1: T1, p2: T2, p3: T3, p4: T4): T7

      • Parameters

        • p1: T1
        • p2: T2
        • p3: T3
        • p4: T4

        Returns T7

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5, p6: T6): T7

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5
          • p6: T6

          Returns T7

    • p1: T1
    • p2: T2
    • p3: T3
    • p4: T4
    • stub5: UnderscoreStatic
    • p6: T6

    Returns function

      • (p5: T5): T7

      • Parameters

        • p5: T5

        Returns T7

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5, p6: T6): T7

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5
          • p6: T6

          Returns T7

    • stub1: UnderscoreStatic
    • p2: T2
    • p3: T3
    • p4: T4
    • stub5: UnderscoreStatic
    • p6: T6

    Returns function

      • (p1: T1, p5: T5): T7

      • Parameters

        • p1: T1
        • p5: T5

        Returns T7

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5, p6: T6): T7

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5
          • p6: T6

          Returns T7

    • p1: T1
    • stub2: UnderscoreStatic
    • p3: T3
    • p4: T4
    • stub5: UnderscoreStatic
    • p6: T6

    Returns function

      • (p2: T2, p5: T5): T7

      • Parameters

        • p2: T2
        • p5: T5

        Returns T7

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    Parameters

    Returns function

      • (p1: T1, p2: T2, p5: T5): T7

      • Parameters

        • p1: T1
        • p2: T2
        • p5: T5

        Returns T7

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5, p6: T6): T7

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5
          • p6: T6

          Returns T7

    • p1: T1
    • p2: T2
    • stub3: UnderscoreStatic
    • p4: T4
    • stub5: UnderscoreStatic
    • p6: T6

    Returns function

      • (p3: T3, p5: T5): T7

      • Parameters

        • p3: T3
        • p5: T5

        Returns T7

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    Parameters

    Returns function

      • (p1: T1, p3: T3, p5: T5): T7

      • Parameters

        • p1: T1
        • p3: T3
        • p5: T5

        Returns T7

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    Parameters

    Returns function

      • (p2: T2, p3: T3, p5: T5): T7

      • Parameters

        • p2: T2
        • p3: T3
        • p5: T5

        Returns T7

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    Parameters

    Returns function

      • (p1: T1, p2: T2, p3: T3, p5: T5): T7

      • Parameters

        • p1: T1
        • p2: T2
        • p3: T3
        • p5: T5

        Returns T7

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5, p6: T6): T7

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5
          • p6: T6

          Returns T7

    • p1: T1
    • p2: T2
    • p3: T3
    • stub4: UnderscoreStatic
    • stub5: UnderscoreStatic
    • p6: T6

    Returns function

      • (p4: T4, p5: T5): T7

      • Parameters

        • p4: T4
        • p5: T5

        Returns T7

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    Parameters

    Returns function

      • (p1: T1, p4: T4, p5: T5): T7

      • Parameters

        • p1: T1
        • p4: T4
        • p5: T5

        Returns T7

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    Parameters

    Returns function

      • (p2: T2, p4: T4, p5: T5): T7

      • Parameters

        • p2: T2
        • p4: T4
        • p5: T5

        Returns T7

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    Parameters

    Returns function

      • (p1: T1, p2: T2, p4: T4, p5: T5): T7

      • Parameters

        • p1: T1
        • p2: T2
        • p4: T4
        • p5: T5

        Returns T7

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    Parameters

    Returns function

      • (p3: T3, p4: T4, p5: T5): T7

      • Parameters

        • p3: T3
        • p4: T4
        • p5: T5

        Returns T7

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    Parameters

    Returns function

      • (p1: T1, p3: T3, p4: T4, p5: T5): T7

      • Parameters

        • p1: T1
        • p3: T3
        • p4: T4
        • p5: T5

        Returns T7

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    Parameters

    Returns function

      • (p2: T2, p3: T3, p4: T4, p5: T5): T7

      • Parameters

        • p2: T2
        • p3: T3
        • p4: T4
        • p5: T5

        Returns T7

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    Parameters

    Returns function

      • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5): T7

      • Parameters

        • p1: T1
        • p2: T2
        • p3: T3
        • p4: T4
        • p5: T5

        Returns T7

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    • T8

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5, p6: T6, p7: T7): T8

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5
          • p6: T6
          • p7: T7

          Returns T8

    • p1: T1

    Returns function

      • (p2: T2, p3: T3, p4: T4, p5: T5, p6: T6, p7: T7): T8

      • Parameters

        • p2: T2
        • p3: T3
        • p4: T4
        • p5: T5
        • p6: T6
        • p7: T7

        Returns T8

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    • T8

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5, p6: T6, p7: T7): T8

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5
          • p6: T6
          • p7: T7

          Returns T8

    • p1: T1
    • p2: T2

    Returns function

      • (p3: T3, p4: T4, p5: T5, p6: T6, p7: T7): T8

      • Parameters

        • p3: T3
        • p4: T4
        • p5: T5
        • p6: T6
        • p7: T7

        Returns T8

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    • T8

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5, p6: T6, p7: T7): T8

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5
          • p6: T6
          • p7: T7

          Returns T8

    • stub1: UnderscoreStatic
    • p2: T2

    Returns function

      • (p1: T1, p3: T3, p4: T4, p5: T5, p6: T6, p7: T7): T8

      • Parameters

        • p1: T1
        • p3: T3
        • p4: T4
        • p5: T5
        • p6: T6
        • p7: T7

        Returns T8

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    • T8

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5, p6: T6, p7: T7): T8

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5
          • p6: T6
          • p7: T7

          Returns T8

    • p1: T1
    • p2: T2
    • p3: T3

    Returns function

      • (p4: T4, p5: T5, p6: T6, p7: T7): T8

      • Parameters

        • p4: T4
        • p5: T5
        • p6: T6
        • p7: T7

        Returns T8

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    • T8

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5, p6: T6, p7: T7): T8

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5
          • p6: T6
          • p7: T7

          Returns T8

    • stub1: UnderscoreStatic
    • p2: T2
    • p3: T3

    Returns function

      • (p1: T1, p4: T4, p5: T5, p6: T6, p7: T7): T8

      • Parameters

        • p1: T1
        • p4: T4
        • p5: T5
        • p6: T6
        • p7: T7

        Returns T8

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    • T8

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5, p6: T6, p7: T7): T8

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5
          • p6: T6
          • p7: T7

          Returns T8

    • p1: T1
    • stub2: UnderscoreStatic
    • p3: T3

    Returns function

      • (p2: T2, p4: T4, p5: T5, p6: T6, p7: T7): T8

      • Parameters

        • p2: T2
        • p4: T4
        • p5: T5
        • p6: T6
        • p7: T7

        Returns T8

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    • T8

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5, p6: T6, p7: T7): T8

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5
          • p6: T6
          • p7: T7

          Returns T8

    • stub1: UnderscoreStatic
    • stub2: UnderscoreStatic
    • p3: T3

    Returns function

      • (p1: T1, p2: T2, p4: T4, p5: T5, p6: T6, p7: T7): T8

      • Parameters

        • p1: T1
        • p2: T2
        • p4: T4
        • p5: T5
        • p6: T6
        • p7: T7

        Returns T8

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    • T8

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5, p6: T6, p7: T7): T8

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5
          • p6: T6
          • p7: T7

          Returns T8

    • p1: T1
    • p2: T2
    • p3: T3
    • p4: T4

    Returns function

      • (p5: T5, p6: T6, p7: T7): T8

      • Parameters

        • p5: T5
        • p6: T6
        • p7: T7

        Returns T8

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    • T8

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5, p6: T6, p7: T7): T8

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5
          • p6: T6
          • p7: T7

          Returns T8

    • stub1: UnderscoreStatic
    • p2: T2
    • p3: T3
    • p4: T4

    Returns function

      • (p1: T1, p5: T5, p6: T6, p7: T7): T8

      • Parameters

        • p1: T1
        • p5: T5
        • p6: T6
        • p7: T7

        Returns T8

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    • T8

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5, p6: T6, p7: T7): T8

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5
          • p6: T6
          • p7: T7

          Returns T8

    • p1: T1
    • stub2: UnderscoreStatic
    • p3: T3
    • p4: T4

    Returns function

      • (p2: T2, p5: T5, p6: T6, p7: T7): T8

      • Parameters

        • p2: T2
        • p5: T5
        • p6: T6
        • p7: T7

        Returns T8

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    • T8

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5, p6: T6, p7: T7): T8

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5
          • p6: T6
          • p7: T7

          Returns T8

    • stub1: UnderscoreStatic
    • stub2: UnderscoreStatic
    • p3: T3
    • p4: T4

    Returns function

      • (p1: T1, p2: T2, p5: T5, p6: T6, p7: T7): T8

      • Parameters

        • p1: T1
        • p2: T2
        • p5: T5
        • p6: T6
        • p7: T7

        Returns T8

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    • T8

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5, p6: T6, p7: T7): T8

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5
          • p6: T6
          • p7: T7

          Returns T8

    • p1: T1
    • p2: T2
    • stub3: UnderscoreStatic
    • p4: T4

    Returns function

      • (p3: T3, p5: T5, p6: T6, p7: T7): T8

      • Parameters

        • p3: T3
        • p5: T5
        • p6: T6
        • p7: T7

        Returns T8

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    • T8

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5, p6: T6, p7: T7): T8

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5
          • p6: T6
          • p7: T7

          Returns T8

    • stub1: UnderscoreStatic
    • p2: T2
    • stub3: UnderscoreStatic
    • p4: T4

    Returns function

      • (p1: T1, p3: T3, p5: T5, p6: T6, p7: T7): T8

      • Parameters

        • p1: T1
        • p3: T3
        • p5: T5
        • p6: T6
        • p7: T7

        Returns T8

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    • T8

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5, p6: T6, p7: T7): T8

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5
          • p6: T6
          • p7: T7

          Returns T8

    • p1: T1
    • stub2: UnderscoreStatic
    • stub3: UnderscoreStatic
    • p4: T4

    Returns function

      • (p2: T2, p3: T3, p5: T5, p6: T6, p7: T7): T8

      • Parameters

        • p2: T2
        • p3: T3
        • p5: T5
        • p6: T6
        • p7: T7

        Returns T8

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    • T8

    Parameters

    Returns function

      • (p1: T1, p2: T2, p3: T3, p5: T5, p6: T6, p7: T7): T8

      • Parameters

        • p1: T1
        • p2: T2
        • p3: T3
        • p5: T5
        • p6: T6
        • p7: T7

        Returns T8

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    • T8

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5, p6: T6, p7: T7): T8

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5
          • p6: T6
          • p7: T7

          Returns T8

    • p1: T1
    • p2: T2
    • p3: T3
    • p4: T4
    • p5: T5

    Returns function

      • (p6: T6, p7: T7): T8

      • Parameters

        • p6: T6
        • p7: T7

        Returns T8

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    • T8

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5, p6: T6, p7: T7): T8

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5
          • p6: T6
          • p7: T7

          Returns T8

    • stub1: UnderscoreStatic
    • p2: T2
    • p3: T3
    • p4: T4
    • p5: T5

    Returns function

      • (p1: T1, p6: T6, p7: T7): T8

      • Parameters

        • p1: T1
        • p6: T6
        • p7: T7

        Returns T8

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    • T8

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5, p6: T6, p7: T7): T8

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5
          • p6: T6
          • p7: T7

          Returns T8

    • p1: T1
    • stub2: UnderscoreStatic
    • p3: T3
    • p4: T4
    • p5: T5

    Returns function

      • (p2: T2, p6: T6, p7: T7): T8

      • Parameters

        • p2: T2
        • p6: T6
        • p7: T7

        Returns T8

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    • T8

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5, p6: T6, p7: T7): T8

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5
          • p6: T6
          • p7: T7

          Returns T8

    • stub1: UnderscoreStatic
    • stub2: UnderscoreStatic
    • p3: T3
    • p4: T4
    • p5: T5

    Returns function

      • (p1: T1, p2: T2, p6: T6, p7: T7): T8

      • Parameters

        • p1: T1
        • p2: T2
        • p6: T6
        • p7: T7

        Returns T8

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    • T8

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5, p6: T6, p7: T7): T8

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5
          • p6: T6
          • p7: T7

          Returns T8

    • p1: T1
    • p2: T2
    • stub3: UnderscoreStatic
    • p4: T4
    • p5: T5

    Returns function

      • (p3: T3, p6: T6, p7: T7): T8

      • Parameters

        • p3: T3
        • p6: T6
        • p7: T7

        Returns T8

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    • T8

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5, p6: T6, p7: T7): T8

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5
          • p6: T6
          • p7: T7

          Returns T8

    • stub1: UnderscoreStatic
    • p2: T2
    • stub3: UnderscoreStatic
    • p4: T4
    • p5: T5

    Returns function

      • (p1: T1, p3: T3, p6: T6, p7: T7): T8

      • Parameters

        • p1: T1
        • p3: T3
        • p6: T6
        • p7: T7

        Returns T8

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    • T8

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5, p6: T6, p7: T7): T8

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5
          • p6: T6
          • p7: T7

          Returns T8

    • p1: T1
    • stub2: UnderscoreStatic
    • stub3: UnderscoreStatic
    • p4: T4
    • p5: T5

    Returns function

      • (p2: T2, p3: T3, p6: T6, p7: T7): T8

      • Parameters

        • p2: T2
        • p3: T3
        • p6: T6
        • p7: T7

        Returns T8

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    • T8

    Parameters

    Returns function

      • (p1: T1, p2: T2, p3: T3, p6: T6, p7: T7): T8

      • Parameters

        • p1: T1
        • p2: T2
        • p3: T3
        • p6: T6
        • p7: T7

        Returns T8

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    • T8

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5, p6: T6, p7: T7): T8

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5
          • p6: T6
          • p7: T7

          Returns T8

    • p1: T1
    • p2: T2
    • p3: T3
    • stub4: UnderscoreStatic
    • p5: T5

    Returns function

      • (p4: T4, p6: T6, p7: T7): T8

      • Parameters

        • p4: T4
        • p6: T6
        • p7: T7

        Returns T8

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    • T8

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5, p6: T6, p7: T7): T8

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5
          • p6: T6
          • p7: T7

          Returns T8

    • stub1: UnderscoreStatic
    • p2: T2
    • p3: T3
    • stub4: UnderscoreStatic
    • p5: T5

    Returns function

      • (p1: T1, p4: T4, p6: T6, p7: T7): T8

      • Parameters

        • p1: T1
        • p4: T4
        • p6: T6
        • p7: T7

        Returns T8

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    • T8

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5, p6: T6, p7: T7): T8

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5
          • p6: T6
          • p7: T7

          Returns T8

    • p1: T1
    • stub2: UnderscoreStatic
    • p3: T3
    • stub4: UnderscoreStatic
    • p5: T5

    Returns function

      • (p2: T2, p4: T4, p6: T6, p7: T7): T8

      • Parameters

        • p2: T2
        • p4: T4
        • p6: T6
        • p7: T7

        Returns T8

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    • T8

    Parameters

    Returns function

      • (p1: T1, p2: T2, p4: T4, p6: T6, p7: T7): T8

      • Parameters

        • p1: T1
        • p2: T2
        • p4: T4
        • p6: T6
        • p7: T7

        Returns T8

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    • T8

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5, p6: T6, p7: T7): T8

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5
          • p6: T6
          • p7: T7

          Returns T8

    • p1: T1
    • p2: T2
    • stub3: UnderscoreStatic
    • stub4: UnderscoreStatic
    • p5: T5

    Returns function

      • (p3: T3, p4: T4, p6: T6, p7: T7): T8

      • Parameters

        • p3: T3
        • p4: T4
        • p6: T6
        • p7: T7

        Returns T8

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    • T8

    Parameters

    Returns function

      • (p1: T1, p3: T3, p4: T4, p6: T6, p7: T7): T8

      • Parameters

        • p1: T1
        • p3: T3
        • p4: T4
        • p6: T6
        • p7: T7

        Returns T8

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    • T8

    Parameters

    Returns function

      • (p2: T2, p3: T3, p4: T4, p6: T6, p7: T7): T8

      • Parameters

        • p2: T2
        • p3: T3
        • p4: T4
        • p6: T6
        • p7: T7

        Returns T8

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    • T8

    Parameters

    Returns function

      • (p1: T1, p2: T2, p3: T3, p4: T4, p6: T6, p7: T7): T8

      • Parameters

        • p1: T1
        • p2: T2
        • p3: T3
        • p4: T4
        • p6: T6
        • p7: T7

        Returns T8

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    • T8

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5, p6: T6, p7: T7): T8

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5
          • p6: T6
          • p7: T7

          Returns T8

    • p1: T1
    • p2: T2
    • p3: T3
    • p4: T4
    • p5: T5
    • p6: T6

    Returns function

      • (p7: T7): T8

      • Parameters

        • p7: T7

        Returns T8

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    • T8

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5, p6: T6, p7: T7): T8

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5
          • p6: T6
          • p7: T7

          Returns T8

    • stub1: UnderscoreStatic
    • p2: T2
    • p3: T3
    • p4: T4
    • p5: T5
    • p6: T6

    Returns function

      • (p1: T1, p7: T7): T8

      • Parameters

        • p1: T1
        • p7: T7

        Returns T8

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    • T8

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5, p6: T6, p7: T7): T8

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5
          • p6: T6
          • p7: T7

          Returns T8

    • p1: T1
    • stub2: UnderscoreStatic
    • p3: T3
    • p4: T4
    • p5: T5
    • p6: T6

    Returns function

      • (p2: T2, p7: T7): T8

      • Parameters

        • p2: T2
        • p7: T7

        Returns T8

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    • T8

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5, p6: T6, p7: T7): T8

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5
          • p6: T6
          • p7: T7

          Returns T8

    • stub1: UnderscoreStatic
    • stub2: UnderscoreStatic
    • p3: T3
    • p4: T4
    • p5: T5
    • p6: T6

    Returns function

      • (p1: T1, p2: T2, p7: T7): T8

      • Parameters

        • p1: T1
        • p2: T2
        • p7: T7

        Returns T8

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    • T8

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5, p6: T6, p7: T7): T8

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5
          • p6: T6
          • p7: T7

          Returns T8

    • p1: T1
    • p2: T2
    • stub3: UnderscoreStatic
    • p4: T4
    • p5: T5
    • p6: T6

    Returns function

      • (p3: T3, p7: T7): T8

      • Parameters

        • p3: T3
        • p7: T7

        Returns T8

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    • T8

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5, p6: T6, p7: T7): T8

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5
          • p6: T6
          • p7: T7

          Returns T8

    • stub1: UnderscoreStatic
    • p2: T2
    • stub3: UnderscoreStatic
    • p4: T4
    • p5: T5
    • p6: T6

    Returns function

      • (p1: T1, p3: T3, p7: T7): T8

      • Parameters

        • p1: T1
        • p3: T3
        • p7: T7

        Returns T8

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    • T8

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5, p6: T6, p7: T7): T8

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5
          • p6: T6
          • p7: T7

          Returns T8

    • p1: T1
    • stub2: UnderscoreStatic
    • stub3: UnderscoreStatic
    • p4: T4
    • p5: T5
    • p6: T6

    Returns function

      • (p2: T2, p3: T3, p7: T7): T8

      • Parameters

        • p2: T2
        • p3: T3
        • p7: T7

        Returns T8

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    • T8

    Parameters

    Returns function

      • (p1: T1, p2: T2, p3: T3, p7: T7): T8

      • Parameters

        • p1: T1
        • p2: T2
        • p3: T3
        • p7: T7

        Returns T8

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    • T8

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5, p6: T6, p7: T7): T8

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5
          • p6: T6
          • p7: T7

          Returns T8

    • p1: T1
    • p2: T2
    • p3: T3
    • stub4: UnderscoreStatic
    • p5: T5
    • p6: T6

    Returns function

      • (p4: T4, p7: T7): T8

      • Parameters

        • p4: T4
        • p7: T7

        Returns T8

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    • T8

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5, p6: T6, p7: T7): T8

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5
          • p6: T6
          • p7: T7

          Returns T8

    • stub1: UnderscoreStatic
    • p2: T2
    • p3: T3
    • stub4: UnderscoreStatic
    • p5: T5
    • p6: T6

    Returns function

      • (p1: T1, p4: T4, p7: T7): T8

      • Parameters

        • p1: T1
        • p4: T4
        • p7: T7

        Returns T8

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    • T8

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5, p6: T6, p7: T7): T8

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5
          • p6: T6
          • p7: T7

          Returns T8

    • p1: T1
    • stub2: UnderscoreStatic
    • p3: T3
    • stub4: UnderscoreStatic
    • p5: T5
    • p6: T6

    Returns function

      • (p2: T2, p4: T4, p7: T7): T8

      • Parameters

        • p2: T2
        • p4: T4
        • p7: T7

        Returns T8

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    • T8

    Parameters

    Returns function

      • (p1: T1, p2: T2, p4: T4, p7: T7): T8

      • Parameters

        • p1: T1
        • p2: T2
        • p4: T4
        • p7: T7

        Returns T8

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    • T8

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5, p6: T6, p7: T7): T8

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5
          • p6: T6
          • p7: T7

          Returns T8

    • p1: T1
    • p2: T2
    • stub3: UnderscoreStatic
    • stub4: UnderscoreStatic
    • p5: T5
    • p6: T6

    Returns function

      • (p3: T3, p4: T4, p7: T7): T8

      • Parameters

        • p3: T3
        • p4: T4
        • p7: T7

        Returns T8

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    • T8

    Parameters

    Returns function

      • (p1: T1, p3: T3, p4: T4, p7: T7): T8

      • Parameters

        • p1: T1
        • p3: T3
        • p4: T4
        • p7: T7

        Returns T8

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    • T8

    Parameters

    Returns function

      • (p2: T2, p3: T3, p4: T4, p7: T7): T8

      • Parameters

        • p2: T2
        • p3: T3
        • p4: T4
        • p7: T7

        Returns T8

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    • T8

    Parameters

    Returns function

      • (p1: T1, p2: T2, p3: T3, p4: T4, p7: T7): T8

      • Parameters

        • p1: T1
        • p2: T2
        • p3: T3
        • p4: T4
        • p7: T7

        Returns T8

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    • T8

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5, p6: T6, p7: T7): T8

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5
          • p6: T6
          • p7: T7

          Returns T8

    • p1: T1
    • p2: T2
    • p3: T3
    • p4: T4
    • stub5: UnderscoreStatic
    • p6: T6

    Returns function

      • (p5: T5, p7: T7): T8

      • Parameters

        • p5: T5
        • p7: T7

        Returns T8

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    • T8

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5, p6: T6, p7: T7): T8

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5
          • p6: T6
          • p7: T7

          Returns T8

    • stub1: UnderscoreStatic
    • p2: T2
    • p3: T3
    • p4: T4
    • stub5: UnderscoreStatic
    • p6: T6

    Returns function

      • (p1: T1, p5: T5, p7: T7): T8

      • Parameters

        • p1: T1
        • p5: T5
        • p7: T7

        Returns T8

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    • T8

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5, p6: T6, p7: T7): T8

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5
          • p6: T6
          • p7: T7

          Returns T8

    • p1: T1
    • stub2: UnderscoreStatic
    • p3: T3
    • p4: T4
    • stub5: UnderscoreStatic
    • p6: T6

    Returns function

      • (p2: T2, p5: T5, p7: T7): T8

      • Parameters

        • p2: T2
        • p5: T5
        • p7: T7

        Returns T8

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    • T8

    Parameters

    Returns function

      • (p1: T1, p2: T2, p5: T5, p7: T7): T8

      • Parameters

        • p1: T1
        • p2: T2
        • p5: T5
        • p7: T7

        Returns T8

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    • T8

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5, p6: T6, p7: T7): T8

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5
          • p6: T6
          • p7: T7

          Returns T8

    • p1: T1
    • p2: T2
    • stub3: UnderscoreStatic
    • p4: T4
    • stub5: UnderscoreStatic
    • p6: T6

    Returns function

      • (p3: T3, p5: T5, p7: T7): T8

      • Parameters

        • p3: T3
        • p5: T5
        • p7: T7

        Returns T8

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    • T8

    Parameters

    Returns function

      • (p1: T1, p3: T3, p5: T5, p7: T7): T8

      • Parameters

        • p1: T1
        • p3: T3
        • p5: T5
        • p7: T7

        Returns T8

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    • T8

    Parameters

    Returns function

      • (p2: T2, p3: T3, p5: T5, p7: T7): T8

      • Parameters

        • p2: T2
        • p3: T3
        • p5: T5
        • p7: T7

        Returns T8

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    • T8

    Parameters

    Returns function

      • (p1: T1, p2: T2, p3: T3, p5: T5, p7: T7): T8

      • Parameters

        • p1: T1
        • p2: T2
        • p3: T3
        • p5: T5
        • p7: T7

        Returns T8

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    • T8

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5, p6: T6, p7: T7): T8

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5
          • p6: T6
          • p7: T7

          Returns T8

    • p1: T1
    • p2: T2
    • p3: T3
    • stub4: UnderscoreStatic
    • stub5: UnderscoreStatic
    • p6: T6

    Returns function

      • (p4: T4, p5: T5, p7: T7): T8

      • Parameters

        • p4: T4
        • p5: T5
        • p7: T7

        Returns T8

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    • T8

    Parameters

    Returns function

      • (p1: T1, p4: T4, p5: T5, p7: T7): T8

      • Parameters

        • p1: T1
        • p4: T4
        • p5: T5
        • p7: T7

        Returns T8

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    • T8

    Parameters

    Returns function

      • (p2: T2, p4: T4, p5: T5, p7: T7): T8

      • Parameters

        • p2: T2
        • p4: T4
        • p5: T5
        • p7: T7

        Returns T8

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    • T8

    Parameters

    Returns function

      • (p1: T1, p2: T2, p4: T4, p5: T5, p7: T7): T8

      • Parameters

        • p1: T1
        • p2: T2
        • p4: T4
        • p5: T5
        • p7: T7

        Returns T8

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    • T8

    Parameters

    Returns function

      • (p3: T3, p4: T4, p5: T5, p7: T7): T8

      • Parameters

        • p3: T3
        • p4: T4
        • p5: T5
        • p7: T7

        Returns T8

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    • T8

    Parameters

    Returns function

      • (p1: T1, p3: T3, p4: T4, p5: T5, p7: T7): T8

      • Parameters

        • p1: T1
        • p3: T3
        • p4: T4
        • p5: T5
        • p7: T7

        Returns T8

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    • T8

    Parameters

    Returns function

      • (p2: T2, p3: T3, p4: T4, p5: T5, p7: T7): T8

      • Parameters

        • p2: T2
        • p3: T3
        • p4: T4
        • p5: T5
        • p7: T7

        Returns T8

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    • T8

    Parameters

    Returns function

      • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5, p7: T7): T8

      • Parameters

        • p1: T1
        • p2: T2
        • p3: T3
        • p4: T4
        • p5: T5
        • p7: T7

        Returns T8

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    • T8

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5, p6: T6, p7: T7): T8

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5
          • p6: T6
          • p7: T7

          Returns T8

    • p1: T1
    • p2: T2
    • p3: T3
    • p4: T4
    • p5: T5
    • p6: T6
    • p7: T7

    Returns function

      • (): T8

      • Returns T8

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    • T8

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5, p6: T6, p7: T7): T8

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5
          • p6: T6
          • p7: T7

          Returns T8

    • stub1: UnderscoreStatic
    • p2: T2
    • p3: T3
    • p4: T4
    • p5: T5
    • p6: T6
    • p7: T7

    Returns function

      • (p1: T1): T8

      • Parameters

        • p1: T1

        Returns T8

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    • T8

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5, p6: T6, p7: T7): T8

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5
          • p6: T6
          • p7: T7

          Returns T8

    • p1: T1
    • stub2: UnderscoreStatic
    • p3: T3
    • p4: T4
    • p5: T5
    • p6: T6
    • p7: T7

    Returns function

      • (p2: T2): T8

      • Parameters

        • p2: T2

        Returns T8

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    • T8

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5, p6: T6, p7: T7): T8

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5
          • p6: T6
          • p7: T7

          Returns T8

    • stub1: UnderscoreStatic
    • stub2: UnderscoreStatic
    • p3: T3
    • p4: T4
    • p5: T5
    • p6: T6
    • p7: T7

    Returns function

      • (p1: T1, p2: T2): T8

      • Parameters

        • p1: T1
        • p2: T2

        Returns T8

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    • T8

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5, p6: T6, p7: T7): T8

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5
          • p6: T6
          • p7: T7

          Returns T8

    • p1: T1
    • p2: T2
    • stub3: UnderscoreStatic
    • p4: T4
    • p5: T5
    • p6: T6
    • p7: T7

    Returns function

      • (p3: T3): T8

      • Parameters

        • p3: T3

        Returns T8

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    • T8

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5, p6: T6, p7: T7): T8

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5
          • p6: T6
          • p7: T7

          Returns T8

    • stub1: UnderscoreStatic
    • p2: T2
    • stub3: UnderscoreStatic
    • p4: T4
    • p5: T5
    • p6: T6
    • p7: T7

    Returns function

      • (p1: T1, p3: T3): T8

      • Parameters

        • p1: T1
        • p3: T3

        Returns T8

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    • T8

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5, p6: T6, p7: T7): T8

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5
          • p6: T6
          • p7: T7

          Returns T8

    • p1: T1
    • stub2: UnderscoreStatic
    • stub3: UnderscoreStatic
    • p4: T4
    • p5: T5
    • p6: T6
    • p7: T7

    Returns function

      • (p2: T2, p3: T3): T8

      • Parameters

        • p2: T2
        • p3: T3

        Returns T8

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    • T8

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5, p6: T6, p7: T7): T8

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5
          • p6: T6
          • p7: T7

          Returns T8

    • stub1: UnderscoreStatic
    • stub2: UnderscoreStatic
    • stub3: UnderscoreStatic
    • p4: T4
    • p5: T5
    • p6: T6
    • p7: T7

    Returns function

      • (p1: T1, p2: T2, p3: T3): T8

      • Parameters

        • p1: T1
        • p2: T2
        • p3: T3

        Returns T8

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    • T8

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5, p6: T6, p7: T7): T8

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5
          • p6: T6
          • p7: T7

          Returns T8

    • p1: T1
    • p2: T2
    • p3: T3
    • stub4: UnderscoreStatic
    • p5: T5
    • p6: T6
    • p7: T7

    Returns function

      • (p4: T4): T8

      • Parameters

        • p4: T4

        Returns T8

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    • T8

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5, p6: T6, p7: T7): T8

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5
          • p6: T6
          • p7: T7

          Returns T8

    • stub1: UnderscoreStatic
    • p2: T2
    • p3: T3
    • stub4: UnderscoreStatic
    • p5: T5
    • p6: T6
    • p7: T7

    Returns function

      • (p1: T1, p4: T4): T8

      • Parameters

        • p1: T1
        • p4: T4

        Returns T8

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    • T8

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5, p6: T6, p7: T7): T8

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5
          • p6: T6
          • p7: T7

          Returns T8

    • p1: T1
    • stub2: UnderscoreStatic
    • p3: T3
    • stub4: UnderscoreStatic
    • p5: T5
    • p6: T6
    • p7: T7

    Returns function

      • (p2: T2, p4: T4): T8

      • Parameters

        • p2: T2
        • p4: T4

        Returns T8

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    • T8

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5, p6: T6, p7: T7): T8

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5
          • p6: T6
          • p7: T7

          Returns T8

    • stub1: UnderscoreStatic
    • stub2: UnderscoreStatic
    • p3: T3
    • stub4: UnderscoreStatic
    • p5: T5
    • p6: T6
    • p7: T7

    Returns function

      • (p1: T1, p2: T2, p4: T4): T8

      • Parameters

        • p1: T1
        • p2: T2
        • p4: T4

        Returns T8

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    • T8

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5, p6: T6, p7: T7): T8

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5
          • p6: T6
          • p7: T7

          Returns T8

    • p1: T1
    • p2: T2
    • stub3: UnderscoreStatic
    • stub4: UnderscoreStatic
    • p5: T5
    • p6: T6
    • p7: T7

    Returns function

      • (p3: T3, p4: T4): T8

      • Parameters

        • p3: T3
        • p4: T4

        Returns T8

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    • T8

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5, p6: T6, p7: T7): T8

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5
          • p6: T6
          • p7: T7

          Returns T8

    • stub1: UnderscoreStatic
    • p2: T2
    • stub3: UnderscoreStatic
    • stub4: UnderscoreStatic
    • p5: T5
    • p6: T6
    • p7: T7

    Returns function

      • (p1: T1, p3: T3, p4: T4): T8

      • Parameters

        • p1: T1
        • p3: T3
        • p4: T4

        Returns T8

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    • T8

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5, p6: T6, p7: T7): T8

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5
          • p6: T6
          • p7: T7

          Returns T8

    • p1: T1
    • stub2: UnderscoreStatic
    • stub3: UnderscoreStatic
    • stub4: UnderscoreStatic
    • p5: T5
    • p6: T6
    • p7: T7

    Returns function

      • (p2: T2, p3: T3, p4: T4): T8

      • Parameters

        • p2: T2
        • p3: T3
        • p4: T4

        Returns T8

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    • T8

    Parameters

    Returns function

      • (p1: T1, p2: T2, p3: T3, p4: T4): T8

      • Parameters

        • p1: T1
        • p2: T2
        • p3: T3
        • p4: T4

        Returns T8

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    • T8

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5, p6: T6, p7: T7): T8

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5
          • p6: T6
          • p7: T7

          Returns T8

    • p1: T1
    • p2: T2
    • p3: T3
    • p4: T4
    • stub5: UnderscoreStatic
    • p6: T6
    • p7: T7

    Returns function

      • (p5: T5): T8

      • Parameters

        • p5: T5

        Returns T8

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    • T8

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5, p6: T6, p7: T7): T8

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5
          • p6: T6
          • p7: T7

          Returns T8

    • stub1: UnderscoreStatic
    • p2: T2
    • p3: T3
    • p4: T4
    • stub5: UnderscoreStatic
    • p6: T6
    • p7: T7

    Returns function

      • (p1: T1, p5: T5): T8

      • Parameters

        • p1: T1
        • p5: T5

        Returns T8

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    • T8

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5, p6: T6, p7: T7): T8

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5
          • p6: T6
          • p7: T7

          Returns T8

    • p1: T1
    • stub2: UnderscoreStatic
    • p3: T3
    • p4: T4
    • stub5: UnderscoreStatic
    • p6: T6
    • p7: T7

    Returns function

      • (p2: T2, p5: T5): T8

      • Parameters

        • p2: T2
        • p5: T5

        Returns T8

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    • T8

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5, p6: T6, p7: T7): T8

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5
          • p6: T6
          • p7: T7

          Returns T8

    • stub1: UnderscoreStatic
    • stub2: UnderscoreStatic
    • p3: T3
    • p4: T4
    • stub5: UnderscoreStatic
    • p6: T6
    • p7: T7

    Returns function

      • (p1: T1, p2: T2, p5: T5): T8

      • Parameters

        • p1: T1
        • p2: T2
        • p5: T5

        Returns T8

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    • T8

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5, p6: T6, p7: T7): T8

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5
          • p6: T6
          • p7: T7

          Returns T8

    • p1: T1
    • p2: T2
    • stub3: UnderscoreStatic
    • p4: T4
    • stub5: UnderscoreStatic
    • p6: T6
    • p7: T7

    Returns function

      • (p3: T3, p5: T5): T8

      • Parameters

        • p3: T3
        • p5: T5

        Returns T8

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    • T8

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5, p6: T6, p7: T7): T8

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5
          • p6: T6
          • p7: T7

          Returns T8

    • stub1: UnderscoreStatic
    • p2: T2
    • stub3: UnderscoreStatic
    • p4: T4
    • stub5: UnderscoreStatic
    • p6: T6
    • p7: T7

    Returns function

      • (p1: T1, p3: T3, p5: T5): T8

      • Parameters

        • p1: T1
        • p3: T3
        • p5: T5

        Returns T8

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    • T8

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5, p6: T6, p7: T7): T8

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5
          • p6: T6
          • p7: T7

          Returns T8

    • p1: T1
    • stub2: UnderscoreStatic
    • stub3: UnderscoreStatic
    • p4: T4
    • stub5: UnderscoreStatic
    • p6: T6
    • p7: T7

    Returns function

      • (p2: T2, p3: T3, p5: T5): T8

      • Parameters

        • p2: T2
        • p3: T3
        • p5: T5

        Returns T8

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    • T8

    Parameters

    Returns function

      • (p1: T1, p2: T2, p3: T3, p5: T5): T8

      • Parameters

        • p1: T1
        • p2: T2
        • p3: T3
        • p5: T5

        Returns T8

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    • T8

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5, p6: T6, p7: T7): T8

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5
          • p6: T6
          • p7: T7

          Returns T8

    • p1: T1
    • p2: T2
    • p3: T3
    • stub4: UnderscoreStatic
    • stub5: UnderscoreStatic
    • p6: T6
    • p7: T7

    Returns function

      • (p4: T4, p5: T5): T8

      • Parameters

        • p4: T4
        • p5: T5

        Returns T8

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    • T8

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5, p6: T6, p7: T7): T8

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5
          • p6: T6
          • p7: T7

          Returns T8

    • stub1: UnderscoreStatic
    • p2: T2
    • p3: T3
    • stub4: UnderscoreStatic
    • stub5: UnderscoreStatic
    • p6: T6
    • p7: T7

    Returns function

      • (p1: T1, p4: T4, p5: T5): T8

      • Parameters

        • p1: T1
        • p4: T4
        • p5: T5

        Returns T8

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    • T8

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5, p6: T6, p7: T7): T8

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5
          • p6: T6
          • p7: T7

          Returns T8

    • p1: T1
    • stub2: UnderscoreStatic
    • p3: T3
    • stub4: UnderscoreStatic
    • stub5: UnderscoreStatic
    • p6: T6
    • p7: T7

    Returns function

      • (p2: T2, p4: T4, p5: T5): T8

      • Parameters

        • p2: T2
        • p4: T4
        • p5: T5

        Returns T8

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    • T8

    Parameters

    Returns function

      • (p1: T1, p2: T2, p4: T4, p5: T5): T8

      • Parameters

        • p1: T1
        • p2: T2
        • p4: T4
        • p5: T5

        Returns T8

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    • T8

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5, p6: T6, p7: T7): T8

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5
          • p6: T6
          • p7: T7

          Returns T8

    • p1: T1
    • p2: T2
    • stub3: UnderscoreStatic
    • stub4: UnderscoreStatic
    • stub5: UnderscoreStatic
    • p6: T6
    • p7: T7

    Returns function

      • (p3: T3, p4: T4, p5: T5): T8

      • Parameters

        • p3: T3
        • p4: T4
        • p5: T5

        Returns T8

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    • T8

    Parameters

    Returns function

      • (p1: T1, p3: T3, p4: T4, p5: T5): T8

      • Parameters

        • p1: T1
        • p3: T3
        • p4: T4
        • p5: T5

        Returns T8

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    • T8

    Parameters

    Returns function

      • (p2: T2, p3: T3, p4: T4, p5: T5): T8

      • Parameters

        • p2: T2
        • p3: T3
        • p4: T4
        • p5: T5

        Returns T8

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    • T8

    Parameters

    Returns function

      • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5): T8

      • Parameters

        • p1: T1
        • p2: T2
        • p3: T3
        • p4: T4
        • p5: T5

        Returns T8

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    • T8

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5, p6: T6, p7: T7): T8

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5
          • p6: T6
          • p7: T7

          Returns T8

    • p1: T1
    • p2: T2
    • p3: T3
    • p4: T4
    • p5: T5
    • stub6: UnderscoreStatic
    • p7: T7

    Returns function

      • (p6: T6): T8

      • Parameters

        • p6: T6

        Returns T8

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    • T8

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5, p6: T6, p7: T7): T8

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5
          • p6: T6
          • p7: T7

          Returns T8

    • stub1: UnderscoreStatic
    • p2: T2
    • p3: T3
    • p4: T4
    • p5: T5
    • stub6: UnderscoreStatic
    • p7: T7

    Returns function

      • (p1: T1, p6: T6): T8

      • Parameters

        • p1: T1
        • p6: T6

        Returns T8

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    • T8

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5, p6: T6, p7: T7): T8

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5
          • p6: T6
          • p7: T7

          Returns T8

    • p1: T1
    • stub2: UnderscoreStatic
    • p3: T3
    • p4: T4
    • p5: T5
    • stub6: UnderscoreStatic
    • p7: T7

    Returns function

      • (p2: T2, p6: T6): T8

      • Parameters

        • p2: T2
        • p6: T6

        Returns T8

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    • T8

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5, p6: T6, p7: T7): T8

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5
          • p6: T6
          • p7: T7

          Returns T8

    • stub1: UnderscoreStatic
    • stub2: UnderscoreStatic
    • p3: T3
    • p4: T4
    • p5: T5
    • stub6: UnderscoreStatic
    • p7: T7

    Returns function

      • (p1: T1, p2: T2, p6: T6): T8

      • Parameters

        • p1: T1
        • p2: T2
        • p6: T6

        Returns T8

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    • T8

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5, p6: T6, p7: T7): T8

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5
          • p6: T6
          • p7: T7

          Returns T8

    • p1: T1
    • p2: T2
    • stub3: UnderscoreStatic
    • p4: T4
    • p5: T5
    • stub6: UnderscoreStatic
    • p7: T7

    Returns function

      • (p3: T3, p6: T6): T8

      • Parameters

        • p3: T3
        • p6: T6

        Returns T8

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    • T8

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5, p6: T6, p7: T7): T8

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5
          • p6: T6
          • p7: T7

          Returns T8

    • stub1: UnderscoreStatic
    • p2: T2
    • stub3: UnderscoreStatic
    • p4: T4
    • p5: T5
    • stub6: UnderscoreStatic
    • p7: T7

    Returns function

      • (p1: T1, p3: T3, p6: T6): T8

      • Parameters

        • p1: T1
        • p3: T3
        • p6: T6

        Returns T8

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    • T8

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5, p6: T6, p7: T7): T8

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5
          • p6: T6
          • p7: T7

          Returns T8

    • p1: T1
    • stub2: UnderscoreStatic
    • stub3: UnderscoreStatic
    • p4: T4
    • p5: T5
    • stub6: UnderscoreStatic
    • p7: T7

    Returns function

      • (p2: T2, p3: T3, p6: T6): T8

      • Parameters

        • p2: T2
        • p3: T3
        • p6: T6

        Returns T8

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    • T8

    Parameters

    Returns function

      • (p1: T1, p2: T2, p3: T3, p6: T6): T8

      • Parameters

        • p1: T1
        • p2: T2
        • p3: T3
        • p6: T6

        Returns T8

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    • T8

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5, p6: T6, p7: T7): T8

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5
          • p6: T6
          • p7: T7

          Returns T8

    • p1: T1
    • p2: T2
    • p3: T3
    • stub4: UnderscoreStatic
    • p5: T5
    • stub6: UnderscoreStatic
    • p7: T7

    Returns function

      • (p4: T4, p6: T6): T8

      • Parameters

        • p4: T4
        • p6: T6

        Returns T8

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    • T8

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5, p6: T6, p7: T7): T8

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5
          • p6: T6
          • p7: T7

          Returns T8

    • stub1: UnderscoreStatic
    • p2: T2
    • p3: T3
    • stub4: UnderscoreStatic
    • p5: T5
    • stub6: UnderscoreStatic
    • p7: T7

    Returns function

      • (p1: T1, p4: T4, p6: T6): T8

      • Parameters

        • p1: T1
        • p4: T4
        • p6: T6

        Returns T8

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    • T8

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5, p6: T6, p7: T7): T8

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5
          • p6: T6
          • p7: T7

          Returns T8

    • p1: T1
    • stub2: UnderscoreStatic
    • p3: T3
    • stub4: UnderscoreStatic
    • p5: T5
    • stub6: UnderscoreStatic
    • p7: T7

    Returns function

      • (p2: T2, p4: T4, p6: T6): T8

      • Parameters

        • p2: T2
        • p4: T4
        • p6: T6

        Returns T8

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    • T8

    Parameters

    Returns function

      • (p1: T1, p2: T2, p4: T4, p6: T6): T8

      • Parameters

        • p1: T1
        • p2: T2
        • p4: T4
        • p6: T6

        Returns T8

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    • T8

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5, p6: T6, p7: T7): T8

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5
          • p6: T6
          • p7: T7

          Returns T8

    • p1: T1
    • p2: T2
    • stub3: UnderscoreStatic
    • stub4: UnderscoreStatic
    • p5: T5
    • stub6: UnderscoreStatic
    • p7: T7

    Returns function

      • (p3: T3, p4: T4, p6: T6): T8

      • Parameters

        • p3: T3
        • p4: T4
        • p6: T6

        Returns T8

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    • T8

    Parameters

    Returns function

      • (p1: T1, p3: T3, p4: T4, p6: T6): T8

      • Parameters

        • p1: T1
        • p3: T3
        • p4: T4
        • p6: T6

        Returns T8

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    • T8

    Parameters

    Returns function

      • (p2: T2, p3: T3, p4: T4, p6: T6): T8

      • Parameters

        • p2: T2
        • p3: T3
        • p4: T4
        • p6: T6

        Returns T8

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    • T8

    Parameters

    Returns function

      • (p1: T1, p2: T2, p3: T3, p4: T4, p6: T6): T8

      • Parameters

        • p1: T1
        • p2: T2
        • p3: T3
        • p4: T4
        • p6: T6

        Returns T8

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    • T8

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5, p6: T6, p7: T7): T8

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5
          • p6: T6
          • p7: T7

          Returns T8

    • p1: T1
    • p2: T2
    • p3: T3
    • p4: T4
    • stub5: UnderscoreStatic
    • stub6: UnderscoreStatic
    • p7: T7

    Returns function

      • (p5: T5, p6: T6): T8

      • Parameters

        • p5: T5
        • p6: T6

        Returns T8

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    • T8

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5, p6: T6, p7: T7): T8

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5
          • p6: T6
          • p7: T7

          Returns T8

    • stub1: UnderscoreStatic
    • p2: T2
    • p3: T3
    • p4: T4
    • stub5: UnderscoreStatic
    • stub6: UnderscoreStatic
    • p7: T7

    Returns function

      • (p1: T1, p5: T5, p6: T6): T8

      • Parameters

        • p1: T1
        • p5: T5
        • p6: T6

        Returns T8

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    • T8

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5, p6: T6, p7: T7): T8

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5
          • p6: T6
          • p7: T7

          Returns T8

    • p1: T1
    • stub2: UnderscoreStatic
    • p3: T3
    • p4: T4
    • stub5: UnderscoreStatic
    • stub6: UnderscoreStatic
    • p7: T7

    Returns function

      • (p2: T2, p5: T5, p6: T6): T8

      • Parameters

        • p2: T2
        • p5: T5
        • p6: T6

        Returns T8

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    • T8

    Parameters

    Returns function

      • (p1: T1, p2: T2, p5: T5, p6: T6): T8

      • Parameters

        • p1: T1
        • p2: T2
        • p5: T5
        • p6: T6

        Returns T8

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    • T8

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5, p6: T6, p7: T7): T8

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5
          • p6: T6
          • p7: T7

          Returns T8

    • p1: T1
    • p2: T2
    • stub3: UnderscoreStatic
    • p4: T4
    • stub5: UnderscoreStatic
    • stub6: UnderscoreStatic
    • p7: T7

    Returns function

      • (p3: T3, p5: T5, p6: T6): T8

      • Parameters

        • p3: T3
        • p5: T5
        • p6: T6

        Returns T8

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    • T8

    Parameters

    Returns function

      • (p1: T1, p3: T3, p5: T5, p6: T6): T8

      • Parameters

        • p1: T1
        • p3: T3
        • p5: T5
        • p6: T6

        Returns T8

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    • T8

    Parameters

    Returns function

      • (p2: T2, p3: T3, p5: T5, p6: T6): T8

      • Parameters

        • p2: T2
        • p3: T3
        • p5: T5
        • p6: T6

        Returns T8

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    • T8

    Parameters

    Returns function

      • (p1: T1, p2: T2, p3: T3, p5: T5, p6: T6): T8

      • Parameters

        • p1: T1
        • p2: T2
        • p3: T3
        • p5: T5
        • p6: T6

        Returns T8

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    • T8

    Parameters

    • fn: function
        • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5, p6: T6, p7: T7): T8

        • Parameters

          • p1: T1
          • p2: T2
          • p3: T3
          • p4: T4
          • p5: T5
          • p6: T6
          • p7: T7

          Returns T8

    • p1: T1
    • p2: T2
    • p3: T3
    • stub4: UnderscoreStatic
    • stub5: UnderscoreStatic
    • stub6: UnderscoreStatic
    • p7: T7

    Returns function

      • (p4: T4, p5: T5, p6: T6): T8

      • Parameters

        • p4: T4
        • p5: T5
        • p6: T6

        Returns T8

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    • T8

    Parameters

    Returns function

      • (p1: T1, p4: T4, p5: T5, p6: T6): T8

      • Parameters

        • p1: T1
        • p4: T4
        • p5: T5
        • p6: T6

        Returns T8

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    • T8

    Parameters

    Returns function

      • (p2: T2, p4: T4, p5: T5, p6: T6): T8

      • Parameters

        • p2: T2
        • p4: T4
        • p5: T5
        • p6: T6

        Returns T8

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    • T8

    Parameters

    Returns function

      • (p1: T1, p2: T2, p4: T4, p5: T5, p6: T6): T8

      • Parameters

        • p1: T1
        • p2: T2
        • p4: T4
        • p5: T5
        • p6: T6

        Returns T8

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    • T8

    Parameters

    Returns function

      • (p3: T3, p4: T4, p5: T5, p6: T6): T8

      • Parameters

        • p3: T3
        • p4: T4
        • p5: T5
        • p6: T6

        Returns T8

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    • T8

    Parameters

    Returns function

      • (p1: T1, p3: T3, p4: T4, p5: T5, p6: T6): T8

      • Parameters

        • p1: T1
        • p3: T3
        • p4: T4
        • p5: T5
        • p6: T6

        Returns T8

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    • T8

    Parameters

    Returns function

      • (p2: T2, p3: T3, p4: T4, p5: T5, p6: T6): T8

      • Parameters

        • p2: T2
        • p3: T3
        • p4: T4
        • p5: T5
        • p6: T6

        Returns T8

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    • T8

    Parameters

    Returns function

      • (p1: T1, p2: T2, p3: T3, p4: T4, p5: T5, p6: T6): T8

      • Parameters

        • p1: T1
        • p2: T2
        • p3: T3
        • p4: T4
        • p5: T5
        • p6: T6

        Returns T8

partition

  • partition<T>(array: Array<T>, iterator: ListIterator<T, boolean>, context?: any): T[]

  • Split array into two arrays: one whose elements all satisfy predicate and one whose elements all do not satisfy predicate.

    Type parameters

    • T

    Parameters

    • array: Array<T>

      Array to split in two.

    • iterator: ListIterator<T, boolean>

      Filter iterator function for each element in array.

    • Optional context: any

      this object in iterator, optional.

    Returns T[]

    Array where Array[0] are the elements in array that satisfies the predicate, and Array[1] the elements that did not.

pick

  • pick(object: any, ...keys: any[]): any
  • pick(object: any, fn: function): any

  • Return a copy of the object, filtered to only have values for the whitelisted keys (or array of valid keys).

    keys

    The key/value pairs to keep on object.

    Parameters

    • object: any

      Object to strip unwanted key/value pairs.

    • Rest ...keys: any[]

    Returns any

    Copy of object with only the keys properties.

  • see

    _.pick

    Parameters

    • object: any
    • fn: function
        • (value: any, key: any, object: any): any

        • Parameters

          • value: any
          • key: any
          • object: any

          Returns any

    Returns any

pluck

  • pluck<T>(list: List<T>, propertyName: string): any[]

  • A convenient version of what is perhaps the most common use-case for map: extracting a list of property values.

    Type parameters

    • T: object

    Parameters

    • list: List<T>

      The list to pluck elements out of that have the property propertyName.

    • propertyName: string

      The property to look for on each element within list.

    Returns any[]

    The list of elements within list that have the property propertyName.

property

  • property(key: string): function

  • Returns a function that will itself return the key property of any passed-in object.

    Parameters

    • key: string

      Property of the object.

    Returns function

    Function which accept an object an returns the value of key in that object.

      • (object: Object): any

      • Parameters

        • object: Object

        Returns any

propertyOf

  • propertyOf(object: Object): function

  • Returns a function that will itself return the value of a object key property.

    Parameters

    • object: Object

    Returns function

    Function which accept a key property in object and returns its value.

      • (key: string): any

      • Parameters

        • key: string

          The object to get the property value from.

        Returns any

random

  • random(max: number): number
  • random(min: number, max: number): number

  • Returns a random integer between min and max, inclusive. If you only pass one argument, it will return a number between 0 and that number.

    Parameters

    • max: number

      The maximum random number.

    Returns number

    A random number between 0 and max.

  • see

    _.random

    Parameters

    • min: number

      The minimum random number.

    • max: number

    Returns number

    A random number between min and max.

range

  • range(start: number, stop: number, step?: number): number[]
  • range(stop: number): number[]

  • A function to create flexibly-numbered lists of integers, handy for each and map loops. start, if omitted, defaults to 0; step defaults to 1. Returns a list of integers from start to stop, incremented (or decremented) by step, exclusive.

    Parameters

    • start: number

      Start here.

    • stop: number

      Stop here.

    • Optional step: number

      The number to count up by each iteration, optional, default = 1.

    Returns number[]

    Array of numbers from start to stop with increments of step.

  • see

    _.range

    note

    If start is not specified the implementation will never pull the step (step = arguments[2] || 0)

    Parameters

    • stop: number

      Stop here.

    Returns number[]

    Array of numbers from 0 to stop with increments of 1.

reduce

  • Also known as inject and foldl, reduce boils down a list of values into a single value. Memo is the initial state of the reduction, and each successive step of it should be returned by iterator. The iterator is passed four arguments: the memo, then the value and index (or key) of the iteration, and finally a reference to the entire list.

    Type parameters

    • T

    • TResult

    Parameters

    • list: Collection<T>

      Reduces the elements of this array.

    • iterator: MemoIterator<T, TResult>

      Reduce iterator function for each element in list.

    • Optional memo: TResult

      Initial reduce state.

    • Optional context: any

      this object in iterator, optional.

    Returns TResult

    Reduced object result.

  • Type parameters

    • T

    • TResult

    Parameters

    Returns TResult

reduceRight

  • reduceRight<T, TResult>(list: Collection<T>, iterator: MemoIterator<T, TResult>, memo?: TResult, context?: any): TResult

  • The right-associative version of reduce. Delegates to the JavaScript 1.8 version of reduceRight, if it exists. foldr is not as useful in JavaScript as it would be in a language with lazy evaluation.

    Type parameters

    • T

    • TResult

    Parameters

    • list: Collection<T>

      Reduces the elements of this array.

    • iterator: MemoIterator<T, TResult>

      Reduce iterator function for each element in list.

    • Optional memo: TResult

      Initial reduce state.

    • Optional context: any

      this object in iterator, optional.

    Returns TResult

    Reduced object result.

reject

  • Returns the values in list without the elements that the truth test (iterator) passes. The opposite of filter. Return all the elements for which a truth test fails.

    Type parameters

    • T

    Parameters

    • list: List<T>

      Reject elements within this list.

    • iterator: ListIterator<T, boolean>

      Reject iterator function for each element in list.

    • Optional context: any

      this object in iterator, optional.

    Returns T[]

    The rejected list of elements.

  • see

    _.reject

    Type parameters

    • T

    Parameters

    Returns T[]

rest

  • rest<T>(array: List<T>, n?: number): T[]

  • Returns the rest of the elements in an array. Pass an index to return the values of the array from that index onward.

    Type parameters

    • T

    Parameters

    • array: List<T>

      The array to retrieve all but the first index elements.

    • Optional n: number

      The index to start retrieving elements forward from, optional, default = 1.

    Returns T[]

    Returns the elements of array from index to the end of array.

result

  • result(object: any, property: string, defaultValue?: any): any

  • If the value of the named property is a function then invoke it; otherwise, return it.

    Parameters

    • object: any

      Object to maybe invoke function property on.

    • property: string

      The function by name to invoke on object.

    • Optional defaultValue: any

      The value to be returned in case property doesn't exist or is undefined.

    Returns any

    The result of invoking the function property on `object.

sample

  • Produce a random sample from the list. Pass a number to return n random elements from the list. Otherwise a single random item will be returned.

    Type parameters

    • T

    Parameters

    Returns T[]

    Random sample of n elements in list.

  • see

    _.sample

    Type parameters

    • T

    Parameters

    Returns T

select

  • see

    _.filter

    Type parameters

    • T

    Parameters

    Returns T[]

  • see

    _.filter

    Type parameters

    • T

    Parameters

    Returns T[]

shuffle

  • Returns a shuffled copy of the list, using a version of the Fisher-Yates shuffle.

    Type parameters

    • T

    Parameters

    Returns T[]

    Shuffled copy of list.

size

  • Return the number of values in the list.

    Type parameters

    • T

    Parameters

    • list: Collection<T>

      Count the number of values/elements in this list.

    Returns number

    Number of values in list.

some

  • Returns true if any of the values in the list pass the iterator truth test. Short-circuits and stops traversing the list if a true element is found. Delegates to the native method some, if present.

    Type parameters

    • T

    Parameters

    • list: List<T>

      Truth test against all elements within this list.

    • Optional iterator: ListIterator<T, boolean>

      Trust test iterator function for each element in list.

    • Optional context: any

      this object in iterator, optional.

    Returns boolean

    True if any elements passed the truth test, otherwise false.

  • see

    _.some

    Type parameters

    • T

    Parameters

    Returns boolean

sortBy

  • sortBy<T, TSort>(list: List<T>, iterator?: ListIterator<T, TSort>, context?: any): T[]
  • sortBy<T>(list: List<T>, iterator: string, context?: any): T[]

  • Returns a sorted copy of list, ranked in ascending order by the results of running each value through iterator. Iterator may also be the string name of the property to sort by (eg. length).

    Type parameters

    • T

    • TSort

    Parameters

    • list: List<T>

      Sorts this list.

    • Optional iterator: ListIterator<T, TSort>

      Sort iterator for each element within list.

    • Optional context: any

      this object in iterator, optional.

    Returns T[]

    A sorted copy of list.

  • see

    _.sortBy

    Type parameters

    • T

    Parameters

    • list: List<T>
    • iterator: string

      Sort iterator for each element within list.

    • Optional context: any

    Returns T[]

sortedIndex

  • sortedIndex<T, TSort>(list: List<T>, value: T, iterator?: function, context?: any): number

  • Uses a binary search to determine the index at which the value should be inserted into the list in order to maintain the list's sorted order. If an iterator is passed, it will be used to compute the sort ranking of each value, including the value you pass.

    Type parameters

    • T

    • TSort

    Parameters

    • list: List<T>

      The sorted list.

    • value: T

      The value to determine its index within list.

    • Optional iterator: function

      Iterator to compute the sort ranking of each value, optional.

        • (x: T): TSort

        • Parameters

          • x: T

          Returns TSort

    • Optional context: any

    Returns number

    The index where value should be inserted into list.

tail

  • tail<T>(array: List<T>, n?: number): T[]
  • see

    _.rest

    Type parameters

    • T

    Parameters

    • array: List<T>
    • Optional n: number

    Returns T[]

take

  • take<T>(array: List<T>): T
  • take<T>(array: List<T>, n: number): T[]
  • see

    _.first

    Type parameters

    • T

    Parameters

    Returns T

  • see

    _.first

    Type parameters

    • T

    Parameters

    • array: List<T>
    • n: number

    Returns T[]

tap

  • tap<T>(object: T, intercepter: Function): T

  • Invokes interceptor with the object, and then returns object. The primary purpose of this method is to "tap into" a method chain, in order to perform operations on intermediate results within the chain.

    Type parameters

    • T

    Parameters

    • object: T

      Argument to interceptor.

    • intercepter: Function

      The function to modify object before continuing the method chain.

    Returns T

    Modified object.

template

  • Compiles JavaScript templates into functions that can be evaluated for rendering. Useful for rendering complicated bits of HTML from JSON data sources. Template functions can both interpolate variables, using <%= ... %>, as well as execute arbitrary JavaScript code, with <% ... %>. If you wish to interpolate a value, and have it be HTML-escaped, use <%- ... %> When you evaluate a template function, pass in a data object that has properties corresponding to the template's free variables. If you're writing a one-off, you can pass the data object as the second parameter to template in order to render immediately instead of returning a template function. The settings argument should be a hash containing any _.templateSettings that should be overridden.

    Parameters

    • templateString: string

      Underscore HTML template.

    • Optional settings: TemplateSettings

      Settings to use while compiling.

    Returns function

    Returns the compiled Underscore HTML template.

      • (...data: any[]): string

      • Parameters

        • Rest ...data: any[]

          Data to use when compiling templateString.

        Returns string

throttle

  • Creates and returns a new, throttled version of the passed function, that, when invoked repeatedly, will only actually call the original function at most once per every wait milliseconds. Useful for rate-limiting events that occur faster than you can keep up with. By default, throttle will execute the function as soon as you call it for the first time, and, if you call it again any number of times during the wait period, as soon as that period is over. If you'd like to disable the leading-edge call, pass {leading: false}, and if you'd like to disable the execution on the trailing-edge, pass {trailing: false}.

    Type parameters

    • T: Function

    Parameters

    • func: T

      Function to throttle waitMS ms.

    • wait: number

      The number of milliseconds to wait before fn can be invoked again.

    • Optional options: ThrottleSettings

      Allows for disabling execution of the throttled function on either the leading or trailing edge.

    Returns T

    fn with a throttle of wait.

times

  • times<TResult>(n: number, iterator: function, context?: any): TResult[]

  • Invokes the given iterator function n times. Each invocation of iterator is called with an index argument

    Type parameters

    • TResult

    Parameters

    • n: number

      Number of times to invoke iterator.

    • iterator: function

      Function iterator to invoke n times.

        • (n: number): TResult

        • Parameters

          • n: number

          Returns TResult

    • Optional context: any

      this object in iterator, optional.

    Returns TResult[]

toArray

  • Converts the list (anything that can be iterated over), into a real Array. Useful for transmuting the arguments object.

    Type parameters

    • T

    Parameters

    • list: Collection<T>

      object to transform into an array.

    Returns T[]

    list as an array.

unescape

  • unescape(str: string): string

  • The opposite of escape, replaces &, <, >, ", and ' with their unescaped counterparts.

    Parameters

    • str: string

      HTML escaped string.

    Returns string

    str Raw string.

union

  • union<T>(...arrays: List<T>[]): T[]

  • Computes the union of the passed-in arrays: the list of unique items, in order, that are present in one or more of the arrays.

    Type parameters

    • T

    Parameters

    • Rest ...arrays: List<T>[]

      Array of arrays to compute the union of.

    Returns T[]

    The union of elements within arrays.

uniq

  • uniq<T, TSort>(array: List<T>, isSorted?: boolean, iterator?: ListIterator<T, TSort>, context?: any): T[]
  • uniq<T, TSort>(array: List<T>, iterator?: ListIterator<T, TSort>, context?: any): T[]

  • Produces a duplicate-free version of the array, using === to test object equality. If you know in advance that the array is sorted, passing true for isSorted will run a much faster algorithm. If you want to compute unique items based on a transformation, pass an iterator function.

    Type parameters

    • T

    • TSort

    Parameters

    • array: List<T>

      Array to remove duplicates from.

    • Optional isSorted: boolean

      True if array is already sorted, optional, default = false.

    • Optional iterator: ListIterator<T, TSort>

      Transform the elements of array before comparisons for uniqueness.

    • Optional context: any

      'this' object in iterator, optional.

    Returns T[]

    Copy of array where all elements are unique.

  • see

    _.uniq

    Type parameters

    • T

    • TSort

    Parameters

    • array: List<T>
    • Optional iterator: ListIterator<T, TSort>
    • Optional context: any

    Returns T[]

unique

  • unique<T, TSort>(array: List<T>, iterator?: ListIterator<T, TSort>, context?: any): T[]
  • unique<T, TSort>(array: List<T>, isSorted?: boolean, iterator?: ListIterator<T, TSort>, context?: any): T[]
  • see

    _.uniq

    Type parameters

    • T

    • TSort

    Parameters

    • array: List<T>
    • Optional iterator: ListIterator<T, TSort>
    • Optional context: any

    Returns T[]

  • see

    _.uniq

    Type parameters

    • T

    • TSort

    Parameters

    • array: List<T>
    • Optional isSorted: boolean
    • Optional iterator: ListIterator<T, TSort>
    • Optional context: any

    Returns T[]

uniqueId

  • uniqueId(prefix?: string): string

  • Generate a globally-unique id for client-side models or DOM elements that need one. If prefix is passed, the id will be appended to it. Without prefix, returns an integer.

    Parameters

    • Optional prefix: string

      A prefix string to start the unique ID with.

    Returns string

    Unique string ID beginning with prefix.

unzip

  • unzip(...arrays: any[]): any[]

  • The opposite of zip. Given a number of arrays, returns a series of new arrays, the first of which contains all of the first elements in the input arrays, the second of which contains all of the second elements, and so on. Use with apply to pass in an array of arrays

    Parameters

    • Rest ...arrays: any[]

      The arrays to unzip.

    Returns any[]

    Unzipped version of arrays.

values

  • values<T>(object: Dictionary<T>): T[]
  • values(object: any): any[]

  • Return all of the values of the object's properties.

    Type parameters

    • T

    Parameters

    • object: Dictionary<T>

      Retrieve the values of all the properties on this object.

    Returns T[]

    List of all the values on object.

  • Return all of the values of the object's properties.

    Parameters

    • object: any

      Retrieve the values of all the properties on this object.

    Returns any[]

    List of all the values on object.

where

  • where<T, U>(list: List<T>, properties: U): T[]

  • Looks through each value in the list, returning an array of all the values that contain all of the key-value pairs listed in properties.

    Type parameters

    • T

    • U: object

    Parameters

    • list: List<T>

      List to match elements again properties.

    • properties: U

      The properties to check for on each element within list.

    Returns T[]

    The elements within list that contain the required properties.

without

  • without<T>(array: List<T>, ...values: T[]): T[]

  • Returns a copy of the array with all instances of the values removed.

    Type parameters

    • T

    Parameters

    • array: List<T>

      The array to remove values from.

    • Rest ...values: T[]

      The values to remove from array.

    Returns T[]

    Copy of array without values.

wrap

  • wrap(fn: Function, wrapper: function): Function

  • Wraps the first function inside of the wrapper function, passing it as the first argument. This allows the wrapper to execute code before and after the function runs, adjust the arguments, and execute it conditionally.

    Parameters

    • fn: Function

      Function to wrap.

    • wrapper: function

      The function that will wrap fn.

        • (fn: Function, ...args: any[]): any

        • Parameters

          • fn: Function
          • Rest ...args: any[]

          Returns any

    Returns Function

    Wrapped version of `fn.

zip

  • zip(...arrays: any[]): any[]
  • zip(...arrays: any[]): any[]

  • Merges together the values of each of the arrays with the values at the corresponding position. Useful when you have separate data sources that are coordinated through matching array indexes. If you're working with a matrix of nested arrays, zip.apply can transpose the matrix in a similar fashion.

    Parameters

    • Rest ...arrays: any[]

      The arrays to merge/zip.

    Returns any[]

    Zipped version of arrays.

  • see

    _.zip

    Parameters

    • Rest ...arrays: any[]

    Returns any[]

_Chain

_Chain:

after

  • after(func: Function): _Chain<T>

  • Wrapped type number.

    see

    _.after

    Parameters

    • func: Function

    Returns _Chain<T>

all

  • Wrapped type any[].

    see

    _.all

    Parameters

    • Optional iterator: ListIterator<T, boolean>
    • Optional context: any

    Returns _Chain<T>

allKeys

  • Wrapped type object.

    see

    _.allKeys

    Returns _Chain<string>

any

  • Wrapped type any[].

    see

    _.any

    Parameters

    • Optional iterator: ListIterator<T, boolean>
    • Optional context: any

    Returns _Chain<T>

before

  • before(fn: Function): _Chain<T>

  • Wrapped type number.

    see

    _.before

    Parameters

    • fn: Function

    Returns _Chain<T>

bind

  • bind(object: any, ...arguments: any[]): _Chain<T>

  • Wrapped type Function.

    see

    _.bind

    Parameters

    • object: any
    • Rest ...arguments: any[]

    Returns _Chain<T>

bindAll

  • bindAll(...methodNames: string[]): _Chain<T>

  • Wrapped type object.

    see

    _.bindAll

    Parameters

    • Rest ...methodNames: string[]

    Returns _Chain<T>

chain

  • Wrapped type any.

    see

    _.chain

    Returns _Chain<T>

clone

  • Wrapped type any[].

    see

    _.clone

    Returns _Chain<T>

collect

  • see

    _.map

    Type parameters

    • TResult

    Parameters

    Returns _Chain<TResult>

  • see

    _.map

    Type parameters

    • TResult

    Parameters

    Returns _Chain<TResult>

compact

  • Wrapped type any[].

    see

    _.compact

    Returns _Chain<T>

compose

  • compose(...functions: Function[]): _Chain<T>

  • Wrapped type Function[].

    see

    _.compose

    Parameters

    • Rest ...functions: Function[]

    Returns _Chain<T>

concat

  • concat(...arr: Array<T[]>): _Chain<T>

  • Returns a new array comprised of the array on which it is called joined with the array(s) and/or value(s) provided as arguments.

    Parameters

    • Rest ...arr: Array<T[]>

      Arrays and/or values to concatenate into a new array. See the discussion below for details.

    Returns _Chain<T>

    A new array comprised of the array on which it is called

constant

  • Wrapped type any.

    see

    _.constant

    Returns _Chain<T>

contains

  • contains(value: T): _Chain<T>

  • Wrapped type any[].

    see

    _.contains

    Parameters

    • value: T

    Returns _Chain<T>

countBy

  • countBy(iterator?: ListIterator<T, any>, context?: any): _Chain<T>
  • countBy(iterator: string, context?: any): _Chain<T>

  • Wrapped type any[].

    see

    _.countBy

    Parameters

    • Optional iterator: ListIterator<T, any>
    • Optional context: any

    Returns _Chain<T>

  • Wrapped type any[].

    see

    _.countBy

    Parameters

    • iterator: string
    • Optional context: any

    Returns _Chain<T>

debounce

  • debounce(wait: number, immediate?: boolean): _Chain<T>

  • Wrapped type Function.

    see

    _.debounce

    Parameters

    • wait: number
    • Optional immediate: boolean

    Returns _Chain<T>

defaults

  • defaults(...defaults: any[]): _Chain<T>

  • Wrapped type object.

    see

    _.defaults

    Parameters

    • Rest ...defaults: any[]

    Returns _Chain<T>

defer

  • defer(...arguments: any[]): _Chain<T>

  • Wrapped type Function.

    see

    _.defer

    Parameters

    • Rest ...arguments: any[]

    Returns _Chain<T>

delay

  • delay(wait: number, ...arguments: any[]): _Chain<T>
  • delay(...arguments: any[]): _Chain<T>

  • Wrapped type Function.

    see

    _.delay

    Parameters

    • wait: number
    • Rest ...arguments: any[]

    Returns _Chain<T>

  • see

    _.delay

    Parameters

    • Rest ...arguments: any[]

    Returns _Chain<T>

detect

  • see

    _.find

    Type parameters

    • T

    Parameters

    Returns _ChainSingle<T>

  • see

    _.find

    Type parameters

    • T

    • U: object

    Parameters

    • interator: U

    Returns _ChainSingle<T>

  • see

    _.find

    Type parameters

    • T

    Parameters

    • interator: string

    Returns _ChainSingle<T>

difference

  • Wrapped type any[].

    see

    _.difference

    Parameters

    • Rest ...others: List<T>[]

    Returns _Chain<T>

drop

  • see

    _.rest

    Parameters

    • Optional n: number

    Returns _Chain<T>

each

  • Wrapped type any[].

    see

    _.each

    Parameters

    Returns _Chain<T>

  • see

    _.each

    Parameters

    Returns _Chain<T>

escape

  • Wrapped type string.

    see

    _.escape

    Returns _Chain<T>

every

  • see

    _.all

    Parameters

    • Optional iterator: ListIterator<T, boolean>
    • Optional context: any

    Returns _Chain<T>

extend

  • extend(...sources: any[]): _Chain<T>

  • Wrapped type object.

    see

    _.extend

    Parameters

    • Rest ...sources: any[]

    Returns _Chain<T>

filter

  • Wrapped type any[].

    see

    _.filter

    Parameters

    Returns _Chain<T>

find

  • Wrapped type any[].

    see

    _.find

    Type parameters

    • T

    Parameters

    Returns _ChainSingle<T>

  • see

    _.find

    Type parameters

    • T

    • U: object

    Parameters

    • interator: U

    Returns _ChainSingle<T>

  • see

    _.find

    Type parameters

    • T

    Parameters

    • interator: string

    Returns _ChainSingle<T>

findIndex

  • see

    _.findIndex

    Type parameters

    • T

    Parameters

    Returns _Chain<T>

findLastIndex

  • see

    _.findLastIndex

    Type parameters

    • T

    Parameters

    Returns _Chain<T>

findWhere

  • Wrapped type any[].

    see

    _.findWhere

    Type parameters

    • U: object

    Parameters

    • properties: U

    Returns _ChainSingle<T>

first

  • Wrapped type any[].

    see

    _.first

    Returns _ChainSingle<T>

  • Wrapped type any[].

    see

    _.first

    Parameters

    • n: number

    Returns _Chain<T>

flatten

  • flatten(shallow?: boolean): _Chain<any>

  • Wrapped type any.

    see

    _.flatten

    Parameters

    • Optional shallow: boolean

    Returns _Chain<any>

foldl

  • see

    _.reduce

    Type parameters

    • TResult

    Parameters

    • iterator: MemoIterator<T, TResult>
    • Optional memo: TResult
    • Optional context: any

    Returns _ChainSingle<TResult>

foldr

  • see

    _.reduceRight

    Type parameters

    • TResult

    Parameters

    • iterator: MemoIterator<T, TResult>
    • Optional memo: TResult
    • Optional context: any

    Returns _ChainSingle<TResult>

forEach

  • see

    _.each

    Parameters

    Returns _Chain<T>

  • see

    _.each

    Parameters

    Returns _Chain<T>

functions

  • Wrapped type object.

    see

    _.functions

    Returns _Chain<T>

groupBy

  • Wrapped type any[].

    see

    _.groupBy

    Parameters

    • Optional iterator: ListIterator<T, any>
    • Optional context: any

    Returns _ChainOfArrays<T>

  • Wrapped type any[].

    see

    _.groupBy

    Parameters

    • iterator: string
    • Optional context: any

    Returns _ChainOfArrays<T>

has

  • Wrapped type object.

    see

    _.has

    Parameters

    • key: string

    Returns _Chain<T>

head

  • see

    _.first

    Returns _Chain<T>

  • see

    _.first

    Parameters

    • n: number

    Returns _Chain<T>

identity

  • Wrapped type any.

    see

    _.identity

    Returns _Chain<T>

include

  • include(value: T): _Chain<T>

  • Alias for 'contains'.

    see

    contains

    Parameters

    • value: T

    Returns _Chain<T>

indexBy

  • Wrapped type any[].

    see

    _.indexBy

    Parameters

    Returns _Chain<T>

  • Wrapped type any[].

    see

    _.indexBy

    Parameters

    • iterator: string
    • Optional context: any

    Returns _Chain<T>

indexOf

  • Wrapped type any[].

    see

    _.indexOf

    Parameters

    • value: T
    • Optional isSorted: boolean

    Returns _ChainSingle<T>

  • see

    _.indexOf

    Parameters

    • value: T
    • startFrom: number

    Returns _ChainSingle<T>

initial

  • initial(n?: number): _Chain<T>

  • Wrapped type any[].

    see

    _.initial

    Parameters

    • Optional n: number

    Returns _Chain<T>

inject

  • see

    _.reduce

    Type parameters

    • TResult

    Parameters

    • iterator: MemoIterator<T, TResult>
    • Optional memo: TResult
    • Optional context: any

    Returns _ChainSingle<TResult>

intersection

  • Wrapped type any[][].

    see

    _.intersection

    Parameters

    • Rest ...arrays: List<T>[]

    Returns _Chain<T>

invert

  • Wrapped type object.

    see

    _.invert

    Returns _Chain<T>

invoke

  • invoke(methodName: string, ...arguments: any[]): _Chain<T>

  • Wrapped type any[].

    see

    _.invoke

    Parameters

    • methodName: string
    • Rest ...arguments: any[]

    Returns _Chain<T>

isArguments

  • Wrapped type object.

    see

    _.isArguments

    Returns _Chain<T>

isArray

  • Wrapped type object.

    see

    _.isArray

    Returns _Chain<T>

isBoolean

  • Wrapped type object.

    see

    _.isBoolean

    Returns _Chain<T>

isDate

  • Wrapped type object.

    see

    _.isDate

    Returns _Chain<T>

isElement

  • Wrapped type object.

    see

    _.isElement

    Returns _Chain<T>

isEmpty

  • Wrapped type object.

    see

    _.isEmpty

    Returns _Chain<T>

isEqual

  • isEqual(other: any): _Chain<T>

  • Wrapped type object.

    see

    _.isEqual

    Parameters

    • other: any

    Returns _Chain<T>

isError

  • Wrapped type object.

    see

    _.isError

    Returns _Chain<T>

isFinite

  • Wrapped type object.

    see

    _.isFinite

    Returns _Chain<T>

isFunction

  • Wrapped type object.

    see

    _.isFunction

    Returns _Chain<T>

isMatch

  • Wrapped type object.

    see

    _.isMatch

    Returns _Chain<T>

isNaN

  • Wrapped type object.

    see

    _.isNaN

    Returns _Chain<T>

isNull

  • Wrapped type object.

    see

    _.isNull

    Returns _Chain<T>

isNumber

  • Wrapped type object.

    see

    _.isNumber

    Returns _Chain<T>

isObject

  • Wrapped type object.

    see

    _.isObject

    Returns _Chain<T>

isRegExp

  • Wrapped type object.

    see

    _.isRegExp

    Returns _Chain<T>

isString

  • Wrapped type object.

    see

    _.isString

    Returns _Chain<T>

isUndefined

  • Wrapped type object.

    see

    _.isUndefined

    Returns _Chain<T>

iteratee

  • iteratee(context?: any, argCount?: number): _Chain<T>

  • Wrapped type string|Function|Object.

    see

    _.iteratee

    Parameters

    • Optional context: any
    • Optional argCount: number

    Returns _Chain<T>

join

  • Join all elements of an array into a string.

    Parameters

    • Optional separator: any

      Optional. Specifies a string to separate each element of the array. The separator is converted to a string if necessary. If omitted, the array elements are separated with a comma.

    Returns _ChainSingle<T>

    The string conversions of all array elements joined into one string.

keys

  • Wrapped type object.

    see

    _.keys

    Returns _Chain<string>

last

  • Wrapped type any[].

    see

    _.last

    Returns _ChainSingle<T>

  • Wrapped type any[].

    see

    _.last

    Parameters

    • n: number

    Returns _Chain<T>

lastIndexOf

  • Wrapped type any[].

    see

    _.lastIndexOf

    Parameters

    • value: T
    • Optional from: number

    Returns _ChainSingle<T>

map

  • Wrapped type any[].

    see

    _.map

    Type parameters

    • TArray

    Parameters

    Returns _ChainOfArrays<TArray>

  • Wrapped type any[].

    see

    _.map

    Type parameters

    • TResult

    Parameters

    Returns _Chain<TResult>

  • Wrapped type any[].

    see

    _.map

    Type parameters

    • TArray

    Parameters

    Returns _ChainOfArrays<TArray>

  • Wrapped type any[].

    see

    _.map

    Type parameters

    • TResult

    Parameters

    Returns _Chain<TResult>

matches

  • matches<TResult>(): _Chain<T>

  • Wrapped type any[].

    see

    _.matches

    Type parameters

    • TResult

    Returns _Chain<T>

max

  • Wrapped type number[].

    see

    _.max

    Returns _ChainSingle<T>

  • Wrapped type any[].

    see

    _.max

    Parameters

    Returns _ChainSingle<T>

  • Wrapped type any[].

    see

    _.max

    Parameters

    • Optional iterator: ListIterator<T, any>
    • Optional context: any

    Returns _ChainSingle<T>

memoize

  • memoize(hashFn?: function): _Chain<T>

  • Wrapped type Function.

    see

    _.memoize

    Parameters

    • Optional hashFn: function
        • (n: any): string

        • Parameters

          • n: any

          Returns string

    Returns _Chain<T>

methods

  • see

    _.functions

    Returns _Chain<T>

min

  • Wrapped type number[].

    see

    _.min

    Returns _ChainSingle<T>

  • Wrapped type any[].

    see

    _.min

    Parameters

    Returns _ChainSingle<T>

  • Wrapped type any[].

    see

    _.min

    Parameters

    • Optional iterator: ListIterator<T, any>
    • Optional context: any

    Returns _ChainSingle<T>

mixin

  • Wrapped type object.

    see

    _.mixin

    Returns _Chain<T>

negate

  • Wrapped type Function.

    see

    _.negate

    Returns _Chain<T>

noop

  • Wrapped type any.

    see

    _.noop

    Returns _Chain<T>

object

  • object(...keyValuePairs: any[]): _Chain<T>
  • object(values?: any): _Chain<T>

  • Wrapped type any[][].

    see

    _.object

    Parameters

    • Rest ...keyValuePairs: any[]

    Returns _Chain<T>

  • see

    _.object

    Parameters

    • Optional values: any

    Returns _Chain<T>

omit

  • omit(...keys: string[]): _Chain<T>
  • omit(keys: string[]): _Chain<T>
  • omit(iteratee: Function): _Chain<T>

  • Wrapped type object.

    see

    _.omit

    Parameters

    • Rest ...keys: string[]

    Returns _Chain<T>

  • Parameters

    • keys: string[]

    Returns _Chain<T>

  • Parameters

    • iteratee: Function

    Returns _Chain<T>

once

  • Wrapped type Function.

    see

    _.once

    Returns _Chain<T>

pairs

  • Wrapped type object.

    see

    _.pairs

    Returns _Chain<T>

partial

  • partial(...arguments: any[]): _Chain<T>

  • Wrapped type Function.

    see

    _.partial

    Parameters

    • Rest ...arguments: any[]

    Returns _Chain<T>

partition

  • Wrapped type any[].

    see

    _.partition

    Parameters

    Returns _Chain<T[]>

pick

  • pick(...keys: any[]): _Chain<T>
  • pick(keys: any[]): _Chain<T>
  • pick(fn: function): _Chain<T>

  • Wrapped type object.

    see

    _.pick

    Parameters

    • Rest ...keys: any[]

    Returns _Chain<T>

  • Parameters

    • keys: any[]

    Returns _Chain<T>

  • Parameters

    • fn: function
        • (value: any, key: any, object: any): any

        • Parameters

          • value: any
          • key: any
          • object: any

          Returns any

    Returns _Chain<T>

pluck

  • pluck(propertyName: string): _Chain<any>

  • Wrapped type any[].

    see

    _.pluck

    Parameters

    • propertyName: string

    Returns _Chain<any>

pop

  • Removes the last element from an array and returns that element.

    Returns _ChainSingle<T>

    Returns the popped element.

property

  • Wrapped type string.

    see

    _.property

    Returns _Chain<T>

propertyOf

  • Wrapped type object.

    see

    _.propertyOf

    Returns _Chain<T>

push

  • push(...item: Array<T>): _Chain<T>

  • Adds one or more elements to the end of an array and returns the new length of the array.

    Parameters

    • Rest ...item: Array<T>

      The elements to add to the end of the array.

    Returns _Chain<T>

    The array with the element added to the end.

random

  • Wrapped type number.

    see

    _.random

    Returns _Chain<T>

  • Wrapped type number.

    see

    _.random

    Parameters

    • max: number

    Returns _Chain<T>

range

  • range(stop: number, step?: number): _Chain<T>
  • range(): _Chain<T>

  • Wrapped type number.

    see

    _.range

    Parameters

    • stop: number
    • Optional step: number

    Returns _Chain<T>

  • Wrapped type number.

    see

    _.range

    Returns _Chain<T>

reduce

  • Wrapped type any[].

    see

    _.reduce

    Type parameters

    • TResult

    Parameters

    • iterator: MemoIterator<T, TResult>
    • Optional memo: TResult
    • Optional context: any

    Returns _ChainSingle<TResult>

reduceRight

  • Wrapped type any[].

    see

    _.reduceRight

    Type parameters

    • TResult

    Parameters

    • iterator: MemoIterator<T, TResult>
    • Optional memo: TResult
    • Optional context: any

    Returns _ChainSingle<TResult>

reject

  • Wrapped type any[].

    see

    _.reject

    Parameters

    Returns _Chain<T>

rest

  • Wrapped type any[].

    see

    _.rest

    Parameters

    • Optional n: number

    Returns _Chain<T>

result

  • result(property: string, defaultValue?: any): _Chain<T>

  • Wrapped type object.

    see

    _.result

    Parameters

    • property: string
    • Optional defaultValue: any

    Returns _Chain<T>

reverse

  • Reverses an array in place. The first array element becomes the last and the last becomes the first.

    Returns _Chain<T>

    The reversed array.

sample

  • Wrapped type any[].

    see

    _.sample

    Type parameters

    • T

    Parameters

    • n: number

    Returns _Chain<T>

  • see

    _.sample

    Type parameters

    • T

    Returns _Chain<T>

select

  • see

    _.filter

    Parameters

    Returns _Chain<T>

shift

  • Removes the first element from an array and returns that element. This method changes the length of the array.

    Returns _ChainSingle<T>

    The shifted element.

shuffle

  • Wrapped type any[].

    see

    _.shuffle

    Returns _Chain<T>

size

  • Wrapped type any.

    see

    _.size

    Returns _ChainSingle<number>

slice

  • slice(start: number, end?: number): _Chain<T>

  • Returns a shallow copy of a portion of an array into a new array object.

    Parameters

    • start: number

      Zero-based index at which to begin extraction.

    • Optional end: number

      Optional. Zero-based index at which to end extraction. slice extracts up to but not including end.

    Returns _Chain<T>

    A shallow copy of a portion of an array into a new array object.

some

  • see

    _.any

    Parameters

    • Optional iterator: ListIterator<T, boolean>
    • Optional context: any

    Returns _Chain<T>

sort

  • sort(compareFn: function): _Chain<T>

  • Sorts the elements of an array in place and returns the array. The sort is not necessarily stable. The default sort order is according to string Unicode code points.

    Parameters

    • compareFn: function

      Optional. Specifies a function that defines the sort order. If omitted, the array is sorted according to each character's Unicode code point value, according to the string conversion of each element.

        • (a: T, b: T): boolean

        • Parameters

          • a: T
          • b: T

          Returns boolean

    Returns _Chain<T>

    The sorted array.

sortBy

  • Wrapped type any[].

    see

    _.sortBy

    Parameters

    • Optional iterator: ListIterator<T, any>
    • Optional context: any

    Returns _Chain<T>

  • Wrapped type any[].

    see

    _.sortBy

    Parameters

    • iterator: string
    • Optional context: any

    Returns _Chain<T>

sortedIndex

  • sortedIndex(value: T, iterator?: function, context?: any): _Chain<T>

  • Wrapped type any[].

    see

    _.sortedIndex

    Parameters

    • value: T
    • Optional iterator: function
        • (x: T): any

        • Parameters

          • x: T

          Returns any

    • Optional context: any

    Returns _Chain<T>

splice

  • splice(index: number, quantity: number, ...items: Array<T>): _Chain<T>

  • Changes the content of an array by removing existing elements and/or adding new elements.

    Parameters

    • index: number

      Index at which to start changing the array. If greater than the length of the array, actual starting index will be set to the length of the array. If negative, will begin that many elements from the end.

    • quantity: number

      An integer indicating the number of old array elements to remove. If deleteCount is 0, no elements are removed. In this case, you should specify at least one new element. If deleteCount is greater than the number of elements left in the array starting at index, then all of the elements through the end of the array will be deleted.

    • Rest ...items: Array<T>

      The element to add to the array. If you don't specify any elements, splice will only remove elements from the array.

    Returns _Chain<T>

    An array containing the deleted elements. If only one element is removed, an array of one element is returned. If no elements are removed, an empty array is returned.

tail

  • see

    _.rest

    Parameters

    • Optional n: number

    Returns _Chain<T>

take

  • see

    _.first

    Returns _Chain<T>

  • see

    _.first

    Parameters

    • n: number

    Returns _Chain<T>

tap

  • tap(interceptor: function): _Chain<T>

  • Wrapped type object.

    see

    _.tap

    Parameters

    • interceptor: function
        • (...as: any[]): any

        • Parameters

          • Rest ...as: any[]

          Returns any

    Returns _Chain<T>

template

  • Wrapped type string.

    see

    _.template

    Parameters

    Returns function

      • Parameters

        • Rest ...data: any[]

        Returns _Chain<T>

throttle

  • Wrapped type Function.

    see

    _.throttle

    Parameters

    Returns _Chain<T>

times

  • times<TResult>(iterator: function, context?: any): _Chain<T>

  • Wrapped type number.

    see

    _.times

    Type parameters

    • TResult

    Parameters

    • iterator: function
        • (n: number): TResult

        • Parameters

          • n: number

          Returns TResult

    • Optional context: any

    Returns _Chain<T>

toArray

  • Wrapped type any.

    see

    _.toArray

    Returns _Chain<T>

toString

  • A string representing the specified array and its elements.

    Returns _ChainSingle<T>

    A string representing the specified array and its elements.

unescape

  • Wrapped type string.

    see

    _.unescape

    Returns _Chain<T>

union

  • Wrapped type any[][].

    see

    _.union

    Parameters

    • Rest ...arrays: List<T>[]

    Returns _Chain<T>

uniq

  • Wrapped type any[].

    see

    _.uniq

    Parameters

    • Optional isSorted: boolean
    • Optional iterator: ListIterator<T, any>

    Returns _Chain<T>

  • Wrapped type any[].

    see

    _.uniq

    Type parameters

    • TSort

    Parameters

    • Optional iterator: ListIterator<T, TSort>
    • Optional context: any

    Returns _Chain<T>

unique

  • see

    _.uniq

    Type parameters

    • TSort

    Parameters

    • Optional isSorted: boolean
    • Optional iterator: ListIterator<T, TSort>

    Returns _Chain<T>

  • see

    _.uniq

    Type parameters

    • TSort

    Parameters

    • Optional iterator: ListIterator<T, TSort>
    • Optional context: any

    Returns _Chain<T>

uniqueId

  • Wrapped type string.

    see

    _.uniqueId

    Returns _Chain<T>

unshift

  • unshift(...items: Array<T>): _Chain<T>

  • Adds one or more elements to the beginning of an array and returns the new length of the array.

    Parameters

    • Rest ...items: Array<T>

      The elements to add to the front of the array.

    Returns _Chain<T>

    The array with the element added to the beginning.

unzip

  • unzip(...arrays: any[]): _Chain<T>

  • Wrapped type any[][].

    see

    _.unzip

    Parameters

    • Rest ...arrays: any[]

    Returns _Chain<T>

value

  • value<TResult>(): T[]

  • Wrapped type any.

    see

    _.value

    Type parameters

    • TResult

    Returns T[]

values

  • Wrapped type object.

    see

    _.values

    Returns _Chain<T>

where

  • where<U>(properties: U): _Chain<T>

  • Wrapped type any[].

    see

    _.where

    Type parameters

    • U: object

    Parameters

    • properties: U

    Returns _Chain<T>

without

  • without(...values: T[]): _Chain<T>

  • Wrapped type any[].

    see

    _.without

    Parameters

    • Rest ...values: T[]

    Returns _Chain<T>

wrap

  • wrap(wrapper: Function): function

  • Wrapped type Function.

    see

    _.wrap

    Parameters

    • wrapper: Function

    Returns function

zip

  • zip(...arrays: any[]): _Chain<T>

  • Wrapped type any[][].

    see

    _.zip

    Parameters

    • Rest ...arrays: any[]

    Returns _Chain<T>

_ChainOfArrays

_ChainOfArrays:

after

  • after(func: Function): _Chain<T[]>

  • Wrapped type number.

    see

    _.after

    Parameters

    • func: Function

    Returns _Chain<T[]>

all

  • Wrapped type any[].

    see

    _.all

    Parameters

    • Optional iterator: ListIterator<T[], boolean>
    • Optional context: any

    Returns _Chain<T[]>

allKeys

  • Wrapped type object.

    see

    _.allKeys

    Returns _Chain<string>

any

  • Wrapped type any[].

    see

    _.any

    Parameters

    • Optional iterator: ListIterator<T[], boolean>
    • Optional context: any

    Returns _Chain<T[]>

before

  • before(fn: Function): _Chain<T[]>

  • Wrapped type number.

    see

    _.before

    Parameters

    • fn: Function

    Returns _Chain<T[]>

bind

  • bind(object: any, ...arguments: any[]): _Chain<T[]>

  • Wrapped type Function.

    see

    _.bind

    Parameters

    • object: any
    • Rest ...arguments: any[]

    Returns _Chain<T[]>

bindAll

  • bindAll(...methodNames: string[]): _Chain<T[]>

  • Wrapped type object.

    see

    _.bindAll

    Parameters

    • Rest ...methodNames: string[]

    Returns _Chain<T[]>

chain

  • Wrapped type any.

    see

    _.chain

    Returns _Chain<T[]>

clone

  • Wrapped type any[].

    see

    _.clone

    Returns _Chain<T[]>

collect

  • see

    _.map

    Type parameters

    • TResult

    Parameters

    • iterator: ListIterator<T[], TResult>
    • Optional context: any

    Returns _Chain<TResult>

  • see

    _.map

    Type parameters

    • TResult

    Parameters

    Returns _Chain<TResult>

compact

  • Wrapped type any[].

    see

    _.compact

    Returns _Chain<T[]>

compose

  • compose(...functions: Function[]): _Chain<T[]>

  • Wrapped type Function[].

    see

    _.compose

    Parameters

    • Rest ...functions: Function[]

    Returns _Chain<T[]>

concat

  • concat(...arr: Array<T[]>): _Chain<T[]>

  • Returns a new array comprised of the array on which it is called joined with the array(s) and/or value(s) provided as arguments.

    Parameters

    • Rest ...arr: Array<T[]>

      Arrays and/or values to concatenate into a new array. See the discussion below for details.

    Returns _Chain<T[]>

    A new array comprised of the array on which it is called

constant

  • Wrapped type any.

    see

    _.constant

    Returns _Chain<T[]>

contains

  • contains(value: T[]): _Chain<T[]>

  • Wrapped type any[].

    see

    _.contains

    Parameters

    • value: T[]

    Returns _Chain<T[]>

countBy

  • countBy(iterator?: ListIterator<T[], any>, context?: any): _Chain<T[]>
  • countBy(iterator: string, context?: any): _Chain<T[]>

  • Wrapped type any[].

    see

    _.countBy

    Parameters

    • Optional iterator: ListIterator<T[], any>
    • Optional context: any

    Returns _Chain<T[]>

  • Wrapped type any[].

    see

    _.countBy

    Parameters

    • iterator: string
    • Optional context: any

    Returns _Chain<T[]>

debounce

  • debounce(wait: number, immediate?: boolean): _Chain<T[]>

  • Wrapped type Function.

    see

    _.debounce

    Parameters

    • wait: number
    • Optional immediate: boolean

    Returns _Chain<T[]>

defaults

  • defaults(...defaults: any[]): _Chain<T[]>

  • Wrapped type object.

    see

    _.defaults

    Parameters

    • Rest ...defaults: any[]

    Returns _Chain<T[]>

defer

  • defer(...arguments: any[]): _Chain<T[]>

  • Wrapped type Function.

    see

    _.defer

    Parameters

    • Rest ...arguments: any[]

    Returns _Chain<T[]>

delay

  • delay(wait: number, ...arguments: any[]): _Chain<T[]>
  • delay(...arguments: any[]): _Chain<T[]>

  • Wrapped type Function.

    see

    _.delay

    Parameters

    • wait: number
    • Rest ...arguments: any[]

    Returns _Chain<T[]>

  • see

    _.delay

    Parameters

    • Rest ...arguments: any[]

    Returns _Chain<T[]>

detect

  • see

    _.find

    Type parameters

    • T

    Parameters

    Returns _ChainSingle<T>

  • see

    _.find

    Type parameters

    • T

    • U: object

    Parameters

    • interator: U

    Returns _ChainSingle<T>

  • see

    _.find

    Type parameters

    • T

    Parameters

    • interator: string

    Returns _ChainSingle<T>

difference

  • Wrapped type any[].

    see

    _.difference

    Parameters

    • Rest ...others: List<T[]>[]

    Returns _Chain<T[]>

drop

  • drop(n?: number): _Chain<T[]>
  • see

    _.rest

    Parameters

    • Optional n: number

    Returns _Chain<T[]>

each

  • Wrapped type any[].

    see

    _.each

    Parameters

    Returns _Chain<T[]>

  • see

    _.each

    Parameters

    Returns _Chain<T[]>

escape

  • Wrapped type string.

    see

    _.escape

    Returns _Chain<T[]>

every

  • see

    _.all

    Parameters

    • Optional iterator: ListIterator<T[], boolean>
    • Optional context: any

    Returns _Chain<T[]>

extend

  • extend(...sources: any[]): _Chain<T[]>

  • Wrapped type object.

    see

    _.extend

    Parameters

    • Rest ...sources: any[]

    Returns _Chain<T[]>

filter

  • Wrapped type any[].

    see

    _.filter

    Parameters

    • iterator: ListIterator<T[], boolean>
    • Optional context: any

    Returns _Chain<T[]>

find

  • Wrapped type any[].

    see

    _.find

    Type parameters

    • T

    Parameters

    Returns _ChainSingle<T>

  • see

    _.find

    Type parameters

    • T

    • U: object

    Parameters

    • interator: U

    Returns _ChainSingle<T>

  • see

    _.find

    Type parameters

    • T

    Parameters

    • interator: string

    Returns _ChainSingle<T>

findIndex

  • see

    _.findIndex

    Type parameters

    • T

    Parameters

    Returns _Chain<T>

findLastIndex

  • see

    _.findLastIndex

    Type parameters

    • T

    Parameters

    Returns _Chain<T>

findWhere

  • Wrapped type any[].

    see

    _.findWhere

    Type parameters

    • U: object

    Parameters

    • properties: U

    Returns _ChainSingle<T[]>

first

  • Wrapped type any[].

    see

    _.first

    Returns _ChainSingle<T[]>

  • Wrapped type any[].

    see

    _.first

    Parameters

    • n: number

    Returns _Chain<T[]>

flatten

  • Returns _Chain<T>

foldl

  • see

    _.reduce

    Type parameters

    • TResult

    Parameters

    • iterator: MemoIterator<T[], TResult>
    • Optional memo: TResult
    • Optional context: any

    Returns _ChainSingle<TResult>

foldr

  • see

    _.reduceRight

    Type parameters

    • TResult

    Parameters

    • iterator: MemoIterator<T[], TResult>
    • Optional memo: TResult
    • Optional context: any

    Returns _ChainSingle<TResult>

forEach

  • see

    _.each

    Parameters

    Returns _Chain<T[]>

  • see

    _.each

    Parameters

    Returns _Chain<T[]>

functions

  • Wrapped type object.

    see

    _.functions

    Returns _Chain<T[]>

groupBy

  • Wrapped type any[].

    see

    _.groupBy

    Parameters

    • Optional iterator: ListIterator<T[], any>
    • Optional context: any

    Returns _ChainOfArrays<T[]>

  • Wrapped type any[].

    see

    _.groupBy

    Parameters

    • iterator: string
    • Optional context: any

    Returns _ChainOfArrays<T[]>

has

  • has(key: string): _Chain<T[]>

  • Wrapped type object.

    see

    _.has

    Parameters

    • key: string

    Returns _Chain<T[]>

head

  • see

    _.first

    Returns _Chain<T[]>

  • see

    _.first

    Parameters

    • n: number

    Returns _Chain<T[]>

identity

  • Wrapped type any.

    see

    _.identity

    Returns _Chain<T[]>

include

  • include(value: T[]): _Chain<T[]>

  • Alias for 'contains'.

    see

    contains

    Parameters

    • value: T[]

    Returns _Chain<T[]>

indexBy

  • indexBy(iterator: ListIterator<T[], any>, context?: any): _Chain<T[]>
  • indexBy(iterator: string, context?: any): _Chain<T[]>

  • Wrapped type any[].

    see

    _.indexBy

    Parameters

    Returns _Chain<T[]>

  • Wrapped type any[].

    see

    _.indexBy

    Parameters

    • iterator: string
    • Optional context: any

    Returns _Chain<T[]>

indexOf

  • Wrapped type any[].

    see

    _.indexOf

    Parameters

    • value: T[]
    • Optional isSorted: boolean

    Returns _ChainSingle<T[]>

  • see

    _.indexOf

    Parameters

    • value: T[]
    • startFrom: number

    Returns _ChainSingle<T[]>

initial

  • initial(n?: number): _Chain<T[]>

  • Wrapped type any[].

    see

    _.initial

    Parameters

    • Optional n: number

    Returns _Chain<T[]>

inject

  • see

    _.reduce

    Type parameters

    • TResult

    Parameters

    • iterator: MemoIterator<T[], TResult>
    • Optional memo: TResult
    • Optional context: any

    Returns _ChainSingle<TResult>

intersection

  • intersection(...arrays: List<T[]>[]): _Chain<T[]>

  • Wrapped type any[][].

    see

    _.intersection

    Parameters

    • Rest ...arrays: List<T[]>[]

    Returns _Chain<T[]>

invert

  • Wrapped type object.

    see

    _.invert

    Returns _Chain<T[]>

invoke

  • invoke(methodName: string, ...arguments: any[]): _Chain<T[]>

  • Wrapped type any[].

    see

    _.invoke

    Parameters

    • methodName: string
    • Rest ...arguments: any[]

    Returns _Chain<T[]>

isArguments

  • Wrapped type object.

    see

    _.isArguments

    Returns _Chain<T[]>

isArray

  • Wrapped type object.

    see

    _.isArray

    Returns _Chain<T[]>

isBoolean

  • Wrapped type object.

    see

    _.isBoolean

    Returns _Chain<T[]>

isDate

  • Wrapped type object.

    see

    _.isDate

    Returns _Chain<T[]>

isElement

  • Wrapped type object.

    see

    _.isElement

    Returns _Chain<T[]>

isEmpty

  • Wrapped type object.

    see

    _.isEmpty

    Returns _Chain<T[]>

isEqual

  • isEqual(other: any): _Chain<T[]>

  • Wrapped type object.

    see

    _.isEqual

    Parameters

    • other: any

    Returns _Chain<T[]>

isError

  • Wrapped type object.

    see

    _.isError

    Returns _Chain<T[]>

isFinite

  • Wrapped type object.

    see

    _.isFinite

    Returns _Chain<T[]>

isFunction

  • Wrapped type object.

    see

    _.isFunction

    Returns _Chain<T[]>

isMatch

  • Wrapped type object.

    see

    _.isMatch

    Returns _Chain<T[]>

isNaN

  • Wrapped type object.

    see

    _.isNaN

    Returns _Chain<T[]>

isNull

  • Wrapped type object.

    see

    _.isNull

    Returns _Chain<T[]>

isNumber

  • Wrapped type object.

    see

    _.isNumber

    Returns _Chain<T[]>

isObject

  • Wrapped type object.

    see

    _.isObject

    Returns _Chain<T[]>

isRegExp

  • Wrapped type object.

    see

    _.isRegExp

    Returns _Chain<T[]>

isString

  • Wrapped type object.

    see

    _.isString

    Returns _Chain<T[]>

isUndefined

  • Wrapped type object.

    see

    _.isUndefined

    Returns _Chain<T[]>

iteratee

  • iteratee(context?: any, argCount?: number): _Chain<T[]>

  • Wrapped type string|Function|Object.

    see

    _.iteratee

    Parameters

    • Optional context: any
    • Optional argCount: number

    Returns _Chain<T[]>

join

  • Join all elements of an array into a string.

    Parameters

    • Optional separator: any

      Optional. Specifies a string to separate each element of the array. The separator is converted to a string if necessary. If omitted, the array elements are separated with a comma.

    Returns _ChainSingle<T[]>

    The string conversions of all array elements joined into one string.

keys

  • Wrapped type object.

    see

    _.keys

    Returns _Chain<string>

last

  • Wrapped type any[].

    see

    _.last

    Returns _ChainSingle<T[]>

  • Wrapped type any[].

    see

    _.last

    Parameters

    • n: number

    Returns _Chain<T[]>

lastIndexOf

  • Wrapped type any[].

    see

    _.lastIndexOf

    Parameters

    • value: T[]
    • Optional from: number

    Returns _ChainSingle<T[]>

map

  • Wrapped type any[].

    see

    _.map

    Type parameters

    • TArray

    Parameters

    • iterator: ListIterator<T[], TArray[]>
    • Optional context: any

    Returns _ChainOfArrays<TArray>

  • Wrapped type any[].

    see

    _.map

    Type parameters

    • TResult

    Parameters

    • iterator: ListIterator<T[], TResult>
    • Optional context: any

    Returns _Chain<TResult>

  • Wrapped type any[].

    see

    _.map

    Type parameters

    • TArray

    Parameters

    Returns _ChainOfArrays<TArray>

  • Wrapped type any[].

    see

    _.map

    Type parameters

    • TResult

    Parameters

    Returns _Chain<TResult>

matches

  • matches<TResult>(): _Chain<T[]>

  • Wrapped type any[].

    see

    _.matches

    Type parameters

    • TResult

    Returns _Chain<T[]>

max

  • Wrapped type number[].

    see

    _.max

    Returns _ChainSingle<T[]>

  • Wrapped type any[].

    see

    _.max

    Parameters

    Returns _ChainSingle<T[]>

  • Wrapped type any[].

    see

    _.max

    Parameters

    • Optional iterator: ListIterator<T[], any>
    • Optional context: any

    Returns _ChainSingle<T[]>

memoize

  • memoize(hashFn?: function): _Chain<T[]>

  • Wrapped type Function.

    see

    _.memoize

    Parameters

    • Optional hashFn: function
        • (n: any): string

        • Parameters

          • n: any

          Returns string

    Returns _Chain<T[]>

methods

  • see

    _.functions

    Returns _Chain<T[]>

min

  • Wrapped type number[].

    see

    _.min

    Returns _ChainSingle<T[]>

  • Wrapped type any[].

    see

    _.min

    Parameters

    Returns _ChainSingle<T[]>

  • Wrapped type any[].

    see

    _.min

    Parameters

    • Optional iterator: ListIterator<T[], any>
    • Optional context: any

    Returns _ChainSingle<T[]>

mixin

  • Wrapped type object.

    see

    _.mixin

    Returns _Chain<T[]>

negate

  • Wrapped type Function.

    see

    _.negate

    Returns _Chain<T[]>

noop

  • Wrapped type any.

    see

    _.noop

    Returns _Chain<T[]>

object

  • object(...keyValuePairs: any[]): _Chain<T[]>
  • object(values?: any): _Chain<T[]>

  • Wrapped type any[][].

    see

    _.object

    Parameters

    • Rest ...keyValuePairs: any[]

    Returns _Chain<T[]>

  • see

    _.object

    Parameters

    • Optional values: any

    Returns _Chain<T[]>

omit

  • omit(...keys: string[]): _Chain<T[]>
  • omit(keys: string[]): _Chain<T[]>
  • omit(iteratee: Function): _Chain<T[]>

  • Wrapped type object.

    see

    _.omit

    Parameters

    • Rest ...keys: string[]

    Returns _Chain<T[]>

  • Parameters

    • keys: string[]

    Returns _Chain<T[]>

  • Parameters

    • iteratee: Function

    Returns _Chain<T[]>

once

  • Wrapped type Function.

    see

    _.once

    Returns _Chain<T[]>

pairs

  • Wrapped type object.

    see

    _.pairs

    Returns _Chain<T[]>

partial

  • partial(...arguments: any[]): _Chain<T[]>

  • Wrapped type Function.

    see

    _.partial

    Parameters

    • Rest ...arguments: any[]

    Returns _Chain<T[]>

partition

  • Wrapped type any[].

    see

    _.partition

    Parameters

    • iterator: ListIterator<T[], boolean>
    • Optional context: any

    Returns _Chain<T[]>

pick

  • pick(...keys: any[]): _Chain<T[]>
  • pick(keys: any[]): _Chain<T[]>
  • pick(fn: function): _Chain<T[]>

  • Wrapped type object.

    see

    _.pick

    Parameters

    • Rest ...keys: any[]

    Returns _Chain<T[]>

  • Parameters

    • keys: any[]

    Returns _Chain<T[]>

  • Parameters

    • fn: function
        • (value: any, key: any, object: any): any

        • Parameters

          • value: any
          • key: any
          • object: any

          Returns any

    Returns _Chain<T[]>

pluck

  • pluck(propertyName: string): _Chain<any>

  • Wrapped type any[].

    see

    _.pluck

    Parameters

    • propertyName: string

    Returns _Chain<any>

pop

  • Removes the last element from an array and returns that element.

    Returns _ChainSingle<T[]>

    Returns the popped element.

property

  • Wrapped type string.

    see

    _.property

    Returns _Chain<T[]>

propertyOf

  • Wrapped type object.

    see

    _.propertyOf

    Returns _Chain<T[]>

push

  • push(...item: Array<T[]>): _Chain<T[]>

  • Adds one or more elements to the end of an array and returns the new length of the array.

    Parameters

    • Rest ...item: Array<T[]>

      The elements to add to the end of the array.

    Returns _Chain<T[]>

    The array with the element added to the end.

random

  • Wrapped type number.

    see

    _.random

    Returns _Chain<T[]>

  • Wrapped type number.

    see

    _.random

    Parameters

    • max: number

    Returns _Chain<T[]>

range

  • range(stop: number, step?: number): _Chain<T[]>
  • range(): _Chain<T[]>

  • Wrapped type number.

    see

    _.range

    Parameters

    • stop: number
    • Optional step: number

    Returns _Chain<T[]>

  • Wrapped type number.

    see

    _.range

    Returns _Chain<T[]>

reduce

  • Wrapped type any[].

    see

    _.reduce

    Type parameters

    • TResult

    Parameters

    • iterator: MemoIterator<T[], TResult>
    • Optional memo: TResult
    • Optional context: any

    Returns _ChainSingle<TResult>

reduceRight

  • Wrapped type any[].

    see

    _.reduceRight

    Type parameters

    • TResult

    Parameters

    • iterator: MemoIterator<T[], TResult>
    • Optional memo: TResult
    • Optional context: any

    Returns _ChainSingle<TResult>

reject

  • Wrapped type any[].

    see

    _.reject

    Parameters

    • iterator: ListIterator<T[], boolean>
    • Optional context: any

    Returns _Chain<T[]>

rest

  • rest(n?: number): _Chain<T[]>

  • Wrapped type any[].

    see

    _.rest

    Parameters

    • Optional n: number

    Returns _Chain<T[]>

result

  • result(property: string, defaultValue?: any): _Chain<T[]>

  • Wrapped type object.

    see

    _.result

    Parameters

    • property: string
    • Optional defaultValue: any

    Returns _Chain<T[]>

reverse

  • Reverses an array in place. The first array element becomes the last and the last becomes the first.

    Returns _Chain<T[]>

    The reversed array.

sample

  • Wrapped type any[].

    see

    _.sample

    Type parameters

    • T

    Parameters

    • n: number

    Returns _Chain<T>

  • see

    _.sample

    Type parameters

    • T

    Returns _Chain<T>

select

  • see

    _.filter

    Parameters

    • iterator: ListIterator<T[], boolean>
    • Optional context: any

    Returns _Chain<T[]>

shift

  • Removes the first element from an array and returns that element. This method changes the length of the array.

    Returns _ChainSingle<T[]>

    The shifted element.

shuffle

  • Wrapped type any[].

    see

    _.shuffle

    Returns _Chain<T[]>

size

  • Wrapped type any.

    see

    _.size

    Returns _ChainSingle<number>

slice

  • slice(start: number, end?: number): _Chain<T[]>

  • Returns a shallow copy of a portion of an array into a new array object.

    Parameters

    • start: number

      Zero-based index at which to begin extraction.

    • Optional end: number

      Optional. Zero-based index at which to end extraction. slice extracts up to but not including end.

    Returns _Chain<T[]>

    A shallow copy of a portion of an array into a new array object.

some

  • see

    _.any

    Parameters

    • Optional iterator: ListIterator<T[], boolean>
    • Optional context: any

    Returns _Chain<T[]>

sort

  • sort(compareFn: function): _Chain<T[]>

  • Sorts the elements of an array in place and returns the array. The sort is not necessarily stable. The default sort order is according to string Unicode code points.

    Parameters

    • compareFn: function

      Optional. Specifies a function that defines the sort order. If omitted, the array is sorted according to each character's Unicode code point value, according to the string conversion of each element.

        • (a: T[], b: T[]): boolean

        • Parameters

          • a: T[]
          • b: T[]

          Returns boolean

    Returns _Chain<T[]>

    The sorted array.

sortBy

  • sortBy(iterator?: ListIterator<T[], any>, context?: any): _Chain<T[]>
  • sortBy(iterator: string, context?: any): _Chain<T[]>

  • Wrapped type any[].

    see

    _.sortBy

    Parameters

    • Optional iterator: ListIterator<T[], any>
    • Optional context: any

    Returns _Chain<T[]>

  • Wrapped type any[].

    see

    _.sortBy

    Parameters

    • iterator: string
    • Optional context: any

    Returns _Chain<T[]>

sortedIndex

  • sortedIndex(value: T[], iterator?: function, context?: any): _Chain<T[]>

  • Wrapped type any[].

    see

    _.sortedIndex

    Parameters

    • value: T[]
    • Optional iterator: function
        • (x: T[]): any

        • Parameters

          • x: T[]

          Returns any

    • Optional context: any

    Returns _Chain<T[]>

splice

  • splice(index: number, quantity: number, ...items: Array<T[]>): _Chain<T[]>

  • Changes the content of an array by removing existing elements and/or adding new elements.

    Parameters

    • index: number

      Index at which to start changing the array. If greater than the length of the array, actual starting index will be set to the length of the array. If negative, will begin that many elements from the end.

    • quantity: number

      An integer indicating the number of old array elements to remove. If deleteCount is 0, no elements are removed. In this case, you should specify at least one new element. If deleteCount is greater than the number of elements left in the array starting at index, then all of the elements through the end of the array will be deleted.

    • Rest ...items: Array<T[]>

      The element to add to the array. If you don't specify any elements, splice will only remove elements from the array.

    Returns _Chain<T[]>

    An array containing the deleted elements. If only one element is removed, an array of one element is returned. If no elements are removed, an empty array is returned.

tail

  • tail(n?: number): _Chain<T[]>
  • see

    _.rest

    Parameters

    • Optional n: number

    Returns _Chain<T[]>

take

  • see

    _.first

    Returns _Chain<T[]>

  • see

    _.first

    Parameters

    • n: number

    Returns _Chain<T[]>

tap

  • tap(interceptor: function): _Chain<T[]>

  • Wrapped type object.

    see

    _.tap

    Parameters

    • interceptor: function
        • (...as: any[]): any

        • Parameters

          • Rest ...as: any[]

          Returns any

    Returns _Chain<T[]>

template

  • Wrapped type string.

    see

    _.template

    Parameters

    Returns function

      • (...data: any[]): _Chain<T[]>

      • Parameters

        • Rest ...data: any[]

        Returns _Chain<T[]>

throttle

  • Wrapped type Function.

    see

    _.throttle

    Parameters

    Returns _Chain<T[]>

times

  • times<TResult>(iterator: function, context?: any): _Chain<T[]>

  • Wrapped type number.

    see

    _.times

    Type parameters

    • TResult

    Parameters

    • iterator: function
        • (n: number): TResult

        • Parameters

          • n: number

          Returns TResult

    • Optional context: any

    Returns _Chain<T[]>

toArray

  • Wrapped type any.

    see

    _.toArray

    Returns _Chain<T[]>

toString

  • A string representing the specified array and its elements.

    Returns _ChainSingle<T[]>

    A string representing the specified array and its elements.

unescape

  • Wrapped type string.

    see

    _.unescape

    Returns _Chain<T[]>

union

  • Wrapped type any[][].

    see

    _.union

    Parameters

    • Rest ...arrays: List<T[]>[]

    Returns _Chain<T[]>

uniq

  • Wrapped type any[].

    see

    _.uniq

    Parameters

    • Optional isSorted: boolean
    • Optional iterator: ListIterator<T[], any>

    Returns _Chain<T[]>

  • Wrapped type any[].

    see

    _.uniq

    Type parameters

    • TSort

    Parameters

    • Optional iterator: ListIterator<T[], TSort>
    • Optional context: any

    Returns _Chain<T[]>

unique

  • see

    _.uniq

    Type parameters

    • TSort

    Parameters

    • Optional isSorted: boolean
    • Optional iterator: ListIterator<T[], TSort>

    Returns _Chain<T[]>

  • see

    _.uniq

    Type parameters

    • TSort

    Parameters

    • Optional iterator: ListIterator<T[], TSort>
    • Optional context: any

    Returns _Chain<T[]>

uniqueId

  • Wrapped type string.

    see

    _.uniqueId

    Returns _Chain<T[]>

unshift

  • unshift(...items: Array<T[]>): _Chain<T[]>

  • Adds one or more elements to the beginning of an array and returns the new length of the array.

    Parameters

    • Rest ...items: Array<T[]>

      The elements to add to the front of the array.

    Returns _Chain<T[]>

    The array with the element added to the beginning.

unzip

  • unzip(...arrays: any[]): _Chain<T[]>

  • Wrapped type any[][].

    see

    _.unzip

    Parameters

    • Rest ...arrays: any[]

    Returns _Chain<T[]>

value

  • value<TResult>(): T[]

  • Wrapped type any.

    see

    _.value

    Type parameters

    • TResult

    Returns T[]

values

  • Wrapped type object.

    see

    _.values

    Returns _Chain<T[]>

where

  • where<U>(properties: U): _Chain<T[]>

  • Wrapped type any[].

    see

    _.where

    Type parameters

    • U: object

    Parameters

    • properties: U

    Returns _Chain<T[]>

without

  • without(...values: T[]): _Chain<T[]>

  • Wrapped type any[].

    see

    _.without

    Parameters

    • Rest ...values: T[]

    Returns _Chain<T[]>

wrap

  • wrap(wrapper: Function): function

  • Wrapped type Function.

    see

    _.wrap

    Parameters

    • wrapper: Function

    Returns function

zip

  • zip(...arrays: any[]): _Chain<T[]>

  • Wrapped type any[][].

    see

    _.zip

    Parameters

    • Rest ...arrays: any[]

    Returns _Chain<T[]>

_ChainSingle

_ChainSingle:

value

  • value(): T

  • Returns T

Generated using TypeDoc