faker-js/faker

Credit Card number parameter

Open

#181 opened on Jan 16, 2022

View on GitHub
 (5 comments) (0 reactions) (0 assignees)TypeScript (10,283 stars) (796 forks)batch import
c: docshelp wantedm: financep: 1-normal

Description

In the part of the Finance section of the API docs shown above, I think it would improve the docs if we listed all possible inputs of the 'provider' parameter, such as 'Visa', 'MasterCard', etc. What would happen if someone used gibberish as a parameter there, would an error be thrown?

Contributor guide

Tech stack
typescript
Domain
documentationapi
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
familiarity with faker.js librarybasic markdown editing
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80
Research direction
To address this issue, first locate the documentation source for the Finance section, likely in the docs/ directory or inline JSDoc comments in the finance module source. Check the faker.js finance module code to identify all supported credit card provider values (e.g., 'Visa', 'MasterCard'). Update the documentation to list these values explicitly and describe the behavior for invalid inputs (e.g., thrown error or fallback). Review the issue comments for any additional guidance or consensus on the desired format.
Credit Card number parameter · faker-js/faker#181 | Good First Issue