Effect CommunityEC
Effect Community5mo ago
7 replies
danielo515

JSDoc Comment Incorrectly Describes Argument Name Option

Is this JSDoc comment correct?
/**
 * Creates a file argument.
 *
 * Can optionally provide a custom argument name (defaults to `"file"`).
 *
 * @since 1.0.0
 * @category constructors
 */
export const file: (config?: Args.PathArgsConfig) => Args<string> = InternalArgs.file

It says it accepts an argument name, but it doesn't take any other argument beyond config, which doesn't have any argument name
Was this page helpful?