Interface INativeFunction<T, Unwrap>

interface INativeFunction {
    aliases?: `$${string}`[];
    args?: [...T[]];
    brackets?: boolean;
    deprecated?: boolean;
    description: string;
    examples?: string[];
    execute: NativeFunctionExecutor<T, Unwrap>;
    experimental?: boolean;
    name: `$${string}`;
    output?: ArgType | EnumLike<any> | (ArgType | EnumLike<any>)[];
    unwrap: Unwrap;
    version?: string;
}

Type Parameters

  • T extends [...IArg[]]

  • Unwrap extends boolean = boolean

Properties

aliases? args? brackets? deprecated? description examples? execute experimental? name output? unwrap version?

Properties

Optional aliases

aliases?: `$${string}`[]

Aliases this function has.

Optional args

args?: [...T[]]

Optional brackets

brackets?: boolean

If undefined, function has no brackets.

If false, function can have brackets.

If true, function must have brackets.

Optional deprecated

deprecated?: boolean

description

description: string

Optional examples

examples?: string[]

Deprecated

Not being used.

execute

execute: NativeFunctionExecutor<T, Unwrap>

Optional experimental

experimental?: boolean

name

name: `$${string}`

Optional output

output?: ArgType | EnumLike<any> | (ArgType | EnumLike<any>)[]

unwrap

unwrap: Unwrap

Resolves all arguments and are passed through execute params.

Optional version

version?: string

Do not provide this.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc