Wondering what’s next for npm?Check out our public roadmap! »

@puzzleframework/joi-timezone

1.0.2 • Public • Published

joi-timezone

Provides a Joi rule to validate IANA timezone strings using moment-timezone

Build Status Coverage Status

Usage

Note: requires Joi version >= 9

import BaseJoi from 'joi';
import JoiTimezone from 'joi-timezone';
 
const Joi = BaseJoi.extend(JoiTimezone);
 
// Create a joi schema using the timezone validator;
const schema = Joi.string().timezone();

Results with valid timezone:

Joi.validate("Melbourne/Australia", Joi.string().timezone());
/*
  {
    error: null,
    value: "Melbourne/Australia"
  }
 */

Results with valid timezone returning a moment object:

Joi.validate("Melbourne/Australia", Joi.string().timezone({returnMoment: true}));
/*
  {
    error: null,
    value: {
      ...moment object
    }
  }
 */

Results with invalid timezone:

Joi.validate("Some rubbish", Joi.string().timezone());
/*
{ error: {
    [ValidationError: "value" timezone failure]
    isJoi: true,
    name: 'ValidationError',
    details: [{
      message: '"value" timezone failure',
      path: 'value',
      type: 'string.timezone',
      context: { v: 'Some rubbish', key: 'value' }
    }],
    ...
  },
  value: 'Some rubbish'
}
 */

Install

npm i @puzzleframework/joi-timezone

DownloadsWeekly Downloads

1

Version

1.0.2

License

Apache-2.0

Unpacked Size

6.48 kB

Total Files

8

Last publish

Collaborators

  • avatar