Constructs function signature.
Signature arguments is an object literal containing argument keys and corresponding argument definitions. Keys are argument names with modifiers.
Definition os signature arguments.
new EsSignature({
requiredArg: { comment: 'This argument should be specified in function call' },
'optionalArg?': { comment: 'This argument may be omitted' },
'...rest': { comment: 'This argument amy have multiple values' },
});
Vararg symbol, of any.
Iterates over argument symbols.
Checks whether a function with this signature accepts arguments provided for another one.
Requires argument names to match, and all required arguments present.
Another signature the substituted arguments provided for.
true
is signatures compatible, or false
otherwise.
Calls a function.
Rest
...args: RequiredKeyOf<TArgs> extends neverNamed argument values.
Code snippet containing comma-separated argument values enclosed into parentheses.
Declares function parameters.
Custom per-argument declarations, e.g. containing default values or destructuring.
Code snippet containing comma-separated argument declarations enclosed into parentheses.
Static
fromCreates signature from the given input
.
Builds new signature from input
arguments definition.
Returns input
signature instance as is.
Either function signature or arguments definition.
Signature instance.
Generated using TypeDoc
Function signature declaring function arguments.
Contains named argument args.
Can be used to declare functions and to call it.