sfcode
An Online Competing and Development Environment
|
Set a canonical option identifier to be used anywhere in the API.
</strong> | String _name option name |
this
instance (for chainability)Set a long description for option to be used anywhere in text messages.
</strong> | String _title option title |
this
instance (for chainability)Set a short key for option to be used with one hyphen from command line.
</strong> | String _short |
this
instance (for chainability)Set a short key for option to be used with double hyphens from command line.
</strong> | String _long |
this
instance (for chainability)Make an option boolean, i.e. option without value.
this
instance (for chainability)Makes an option accepts multiple values.
Otherwise, the value will be used by the latter passed.
this
instance (for chainability)Makes an option req.
this
instance (for chainability)Makes an option to act as a command, i.e. program will exit just after option action.
this
instance (for chainability)Set a validation (or value) function for argument.
Value from command line passes through before becoming available from API.
Using for validation and convertion simple types to any values.
</strong> | Function _val validating function, invoked in the context of option instance and has one parameter with value from command line |
this
instance (for chainability)Set a default value for option. Default value passed through validation function as ordinary value.
</strong> | Object _def |
this
instance (for chainability)Make option value inputting stream. It's add useful validation and shortcut for STDIN.
this
instance (for chainability)Make option value outputing stream.
It's add useful validation and shortcut for STDOUT.
this
instance (for chainability)Add action for current option command. This action is performed if the current option is present in parsed options (with any value).
</strong> | Function act action function, invoked in the context of command instance and has the parameters:
|
this
instance (for chainability)Set custom additional completion for current option.
</strong> | Function fn completion generation function, invoked in the context of command instance. Accepts parameters:
|
this
instance (for chainability)Finish chain for current option and return parent command instance.
parent
commandArgument is a unnamed entity.
From command line arguments passed as list of unnamed values.
Set a canonical argument identifier to be used anywhere in text messages.
</strong> | String _name argument name |
this
instance (for chainability)Set a long description for argument to be used anywhere in text messages.
</strong> | String _title argument title |
this
instance (for chainability)Makes an argument accepts multiple values.
Otherwise, the value will be used by the latter passed.
this
instance (for chainability)Makes an argument req.
this
instance (for chainability)Set a validation (or value) function for argument.
Value from command line passes through before becoming available from API.
Using for validation and convertion simple types to any values.
</strong> | Function _val validating function, invoked in the context of argument instance and has one parameter with value from command line |
this
instance (for chainability)Set a default value for argument. Default value passed through validation function as ordinary value.
</strong> | Object _def |
this
instance (for chainability)Make argument value outputing stream.
It's add useful validation and shortcut for STDOUT.
this
instance (for chainability)Set custom additional completion for current argument.
</strong> | Function fn completion generation function, invoked in the context of command instance. Accepts parameters:
|
this
instance (for chainability)Finish chain for current option and return parent command instance.
parent
commandОпределяет канонический идентификатор параметра, используемый в вызовах API.
</strong> | String _name имя параметра |
this
экземпляр параметра (для поддержки цепочки методов)Определяет описание для параметра, используемое в текстовых сообщениях.
</strong> | String _title название параметра |
this
экземпляр параметра (для поддержки цепочки методов)Назначает ключ для короткого имени параметра, передаваемого из командной строки с одинарным дефисом (например, -v
).
</strong> | String _short |
this
экземпляр параметра (для поддержки цепочки методов)Назначает ключ для длинного имени параметра, передаваемого из командной строки с двойным дефисом (например, --version
).
</strong> | String _long |
this
экземпляр параметра (для поддержки цепочки методов)Помечает параметр как логический, т.е. параметр не имеющий значения.
this
экземпляр параметра (для поддержки цепочки методов)Помечает параметр как принимающий множественные значения.
Иначе будет использовано последнее переданное значение параметра.
this
экземпляр параметра (для поддержки цепочки методов)Помечает параметр как обязательный.
this
экземпляр параметра (для поддержки цепочки методов)Интерпретирует параметр как команду, т.е. программа будет завершена сразу после выполнения параметра.
this
экземпляр параметра (для поддержки цепочки методов)Назначает функцию валидации (или трансформации значения) для значения параметра.
Значение, полученное из командной строки, передается в функцию-валидатор прежде чем оно станет доступно из API.
Используется для валидации и трансформации введенных данных.
</strong> | Function _val функция валидации, исполняемая в контексте экземпляра параметра и принимающая в качестве единственного параметра значение, полученное из командной строки |
this
экземпляр параметра (для поддержки цепочки методов)Назначает значение параметра по умолчанию. Это значение также передается в функцию валидации как обычное значение.
</strong> | Object _def |
this
экземпляр параметра (для поддержки цепочки методов)Помечает параметр как принимающий ввод пользователя.
Позволяет использовать валидацию для STDIN.
this
экземпляр параметра (для поддержки цепочки методов)Помечает параметр как вывод.
Позволяет использовать валидацию для STDOUT.
this
экземпляр параметра (для поддержки цепочки методов)Добавляет (или создает) действие для текущего параметра команды. Это действие будет выполнено, если текущий параметр есть в списке полученных параметров (с любым значением).
</strong> | Function act функция, выполняемая в контексте экземпляра текущей команды и принимающая следующие параметры:
|
this
экземпляр параметра (для поддержки цепочки методов)Назначает кастомную функцию автодополнения для текущей команды.
</strong> | Function fn функция-генератор автодоплнения, исполняемая в контексте экземпляра команды. Принимает параметры:
|
this
экземпляр параметра (для поддержки цепочки методов)Завершает цепочку методов текущего параметра и возвращает экземпляр родительской команды.
parent
родительская командаАргумент — неименованная сущность.
Аргументы передаются из командной строки как список неименованных значений.
Определяет канонический идентификатор аргумента, используемый в вызовах API.
</strong> | String _name имя аргумента |
this
экземпляр аргумента (для поддержки цепочки методов)Определяет описание для аргумента, используемое в текстовых сообщениях.
</strong> | String _title описание аргумента |
this
экземпляр аргумента (для поддержки цепочки методов)Помечает аргумент как принимающий множественные значения.
Иначе будет использовано последнее переданное значение аргумента.
this
экземпляр аргумента (для поддержки цепочки методов)Помечает аргумент как обязательный.
this
экземпляр аргумента (для поддержки цепочки методов)Назначает функцию валидации (или трансформации значения) для аргумента.
Значение, полученное из командной строки, передается в функцию-валидатор прежде чем оно станет доступно из API.
Используется для валидации и трансформации введенных данных.
</strong> | Function _val функция валидации, исполняемая в контексте экземпляра аргумента и принимающая в качестве единственного параметра значение, полученное из командной строки |
this
экземпляр аргумента (для поддержки цепочки методов)Назначает дефолтное значение для аргумента. Дефолтное значение передается в функцию валидации как обычное значение.
</strong> | Object _def |
this
экземпляр аргумента (для поддержки цепочки методов)Помечает параметр как вывод.
Позволяет назначить валидацию для STDOUT.
this
экземпляр аргумента (для поддержки цепочки методов)Назначает кастомную функцию автодополнения для текущего аргумента.
</strong> | Function fn функция-генератор автодоплнения, исполняемая в контексте текущей команды. Принимает параметры:
|
this
экземпляр аргумента (для поддержки цепочки методов)Завершает цепочку методов текущего аргумента и возвращает экземпляр родительской команды.
parent
родительская команда