faker-doc

Documentation and examples for Faker

npm install faker-doc
8 downloads in the last week
16 downloads in the last month

faker-doc

Documentation for Faker.js methods that require arguments.

Created for mockerc for API generation.

Format

Faker.documentation.<methodName>.<methodName> = {
    params: [
        {
            description: {String} something about this argument
            type:        {String} string, obj, array, etc
            example:     example value
            acceptable:  Optional {Array} array of possible values
            required:    Optional {Boolean}
        },
        {
            /.../
        }
    ]
}
npm loves you