Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support metadata for schema documentation #4

Open
andrenarchy opened this issue Feb 26, 2019 · 0 comments
Open

Support metadata for schema documentation #4

andrenarchy opened this issue Feb 26, 2019 · 0 comments
Labels
enhancement New feature or request

Comments

@andrenarchy
Copy link
Member

A fefe function could return metadata about what it is doing, for example for

import { date } from 'fefe'
const validateReleaseDate = date({ min: new Date() })

the resulting function could offer a function validateReleaseDate.describe() that returns something like

{
  params: { min: Date(2019-02-26) },
  description: 'A date after 2019-02-26.'
}

The user could also provide a semantic description via

date({ min: new Date(), description: 'The release date.' })

or a function that can use the standard description

date({ min: new Date(), description: msg => `The release date: ${msg}` })

CC @andywer :)

@andrenarchy andrenarchy added the enhancement New feature or request label Feb 26, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant