Function: args()

WARNING

This API is experimental and may change in future versions.

Type-safe schema factory.

Returns the input unchanged at runtime, but provides type inference so that satisfies Args is not needed.

Signature

declare function args<T extends Args>(fields: T): T

Type Parameters

Name	Description
T extends Args	The exact schema type.

Parameters

Name	Type	Description
fields	T	The argument schema object.

Returns

T — The same schema object with its type inferred.

Examples

const common = args({
  verbose: boolean(),
  help: short(boolean(), 'h')
})