Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Documentation for Faker.js methods that require arguments. Created for mockerc for API generation.
JavaScript
branch: master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
Address.js
Helpers.js
PhoneNumber.js
README.md
index.js
package.json
random.js

README.md

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}
        },
        {
            /.../
        }
    ]
}

Bitdeli Badge

Something went wrong with that request. Please try again.