diff options
| author | ST-DDT <[email protected]> | 2024-02-05 09:39:09 +0100 |
|---|---|---|
| committer | GitHub <[email protected]> | 2024-02-05 08:39:09 +0000 |
| commit | acba5b7dd864ee51bc5dbc6861a2d5f3219ed5b2 (patch) | |
| tree | 5d0cd07d093535a20a0781939848b2c92dba98c3 /src/modules/finance/index.ts | |
| parent | acbdae73347aa9cafb253c7c51b677ca762da9c4 (diff) | |
| download | faker-acba5b7dd864ee51bc5dbc6861a2d5f3219ed5b2.tar.xz faker-acba5b7dd864ee51bc5dbc6861a2d5f3219ed5b2.zip | |
docs: missing options jsdocs (#2638)
Diffstat (limited to 'src/modules/finance/index.ts')
| -rw-r--r-- | src/modules/finance/index.ts | 15 |
1 files changed, 15 insertions, 0 deletions
diff --git a/src/modules/finance/index.ts b/src/modules/finance/index.ts index 111db571..f7a84f74 100644 --- a/src/modules/finance/index.ts +++ b/src/modules/finance/index.ts @@ -271,8 +271,23 @@ export class FinanceModule extends ModuleBase { * @since 8.0.0 */ maskedNumber(options?: { + /** + * The length of the unmasked number. + * + * @default 4 + */ length?: number; + /** + * Whether to use surrounding parenthesis. + * + * @default true + */ parens?: boolean; + /** + * Whether to prefix the numbers with an ellipsis. + * + * @default true + */ ellipsis?: boolean; }): string; /** |