mirror of
https://github.com/SillyTavern/SillyTavern.git
synced 2025-06-05 21:59:27 +02:00
add fromProps
This commit is contained in:
@ -19,6 +19,30 @@ export const ARGUMENT_TYPE = {
|
|||||||
|
|
||||||
|
|
||||||
export class SlashCommandArgument {
|
export class SlashCommandArgument {
|
||||||
|
/**
|
||||||
|
* Creates an unnamed argument from a poperties object.
|
||||||
|
* @param {Object} props
|
||||||
|
* @param {string} props.description description of the argument
|
||||||
|
* @param {ARGUMENT_TYPE|ARGUMENT_TYPE[]} props.typeList default: ARGUMENT_TYPE.STRING - list of accepted types (from ARGUMENT_TYPE)
|
||||||
|
* @param {boolean} [props.isRequired] default: false - whether the argument is required (false = optional argument)
|
||||||
|
* @param {boolean} [props.acceptsMultiple] default: false - whether argument accepts multiple values
|
||||||
|
* @param {string|SlashCommandClosure} [props.defaultValue] default value if no value is provided
|
||||||
|
* @param {string|string[]} [props.enumList] list of accepted values
|
||||||
|
*/
|
||||||
|
static fromProps(props) {
|
||||||
|
return new SlashCommandArgument(
|
||||||
|
props.description,
|
||||||
|
props.typeList ?? [ARGUMENT_TYPE.STRING],
|
||||||
|
props.isRequired ?? false,
|
||||||
|
props.acceptsMultiple ?? false,
|
||||||
|
props.defaultValue ?? null,
|
||||||
|
props.enumList ?? [],
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
/**@type {string}*/ description;
|
/**@type {string}*/ description;
|
||||||
/**@type {ARGUMENT_TYPE[]}*/ typeList = [];
|
/**@type {ARGUMENT_TYPE[]}*/ typeList = [];
|
||||||
/**@type {boolean}*/ isRequired = false;
|
/**@type {boolean}*/ isRequired = false;
|
||||||
@ -26,6 +50,7 @@ export class SlashCommandArgument {
|
|||||||
/**@type {string|SlashCommandClosure}*/ defaultValue;
|
/**@type {string|SlashCommandClosure}*/ defaultValue;
|
||||||
/**@type {string[]}*/ enumList = [];
|
/**@type {string[]}*/ enumList = [];
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @param {string} description
|
* @param {string} description
|
||||||
* @param {ARGUMENT_TYPE|ARGUMENT_TYPE[]} types
|
* @param {ARGUMENT_TYPE|ARGUMENT_TYPE[]} types
|
||||||
@ -45,9 +70,38 @@ export class SlashCommandArgument {
|
|||||||
|
|
||||||
|
|
||||||
export class SlashCommandNamedArgument extends SlashCommandArgument {
|
export class SlashCommandNamedArgument extends SlashCommandArgument {
|
||||||
|
/**
|
||||||
|
* Creates an unnamed argument from a poperties object.
|
||||||
|
* @param {Object} props
|
||||||
|
* @param {string} props.name the argument's name
|
||||||
|
* @param {string[]} [props.aliasList] list of aliases
|
||||||
|
* @param {string} props.description description of the argument
|
||||||
|
* @param {ARGUMENT_TYPE|ARGUMENT_TYPE[]} props.typeList default: ARGUMENT_TYPE.STRING - list of accepted types (from ARGUMENT_TYPE)
|
||||||
|
* @param {boolean} [props.isRequired] default: false - whether the argument is required (false = optional argument)
|
||||||
|
* @param {boolean} [props.acceptsMultiple] default: false - whether argument accepts multiple values
|
||||||
|
* @param {string|SlashCommandClosure} [props.defaultValue] default value if no value is provided
|
||||||
|
* @param {string|string[]} [props.enumList] list of accepted values
|
||||||
|
*/
|
||||||
|
static fromProps(props) {
|
||||||
|
return new SlashCommandNamedArgument(
|
||||||
|
props.name,
|
||||||
|
props.description,
|
||||||
|
props.typeList ?? [ARGUMENT_TYPE.STRING],
|
||||||
|
props.isRequired ?? false,
|
||||||
|
props.acceptsMultiple ?? false,
|
||||||
|
props.defaultValue ?? null,
|
||||||
|
props.enumList ?? [],
|
||||||
|
props.aliasList ?? [],
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
/**@type {string}*/ name;
|
/**@type {string}*/ name;
|
||||||
/**@type {string[]}*/ aliasList = [];
|
/**@type {string[]}*/ aliasList = [];
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @param {string} name
|
* @param {string} name
|
||||||
* @param {string} description
|
* @param {string} description
|
||||||
|
Reference in New Issue
Block a user