readme.md

iso8601FullDate

Back to root readme.md

This function uses the rulr.isISO8601FullDate guard to check the input is a valid ISO 8601 Full Date as shown in the example below. It should only throw rulr.InvalidISO8601FullDateError.

import * as rulr from 'rulr'

const constrainToExample = rulr.object({
	required: {
		example: rulr.iso8601FullDate,
	},
})

type Example = rulr.Static<typeof constrainToExample>
// {
//   example: rulr.ISO8601FullDate
// }

// Valid
const example1: Example = constrainToExample({
	example: '2020-01-01',
})

// Invalid: Not a valid ISO 8601 Full Date
const example2: Example = constrainToExample({
	example: '2020-01-01T00:00Z',
})

// Invalid: Not a valid ISO 8601 Full Date
const example2: Example = constrainToExample({
	example: '2020-01',
})

// Invalid: Not a string
const example3: Example = constrainToExample({
	example: 1,
})