Giter Club home page Giter Club logo

js-enums's Introduction

js-enums, Enum in javascript!

NPM version build status Test coverage npm download

npm install js-enums

simple to use

const enum = require('js-enums');

var status = enum([
  {
    name: 'CLOSED',
    ortherInfo: 'status close'
  },
  {
    name: 'OPENED',
    ortherInfo: 'status open'
  }
]);
 
// or declare in this way: 
// var status = enum(['OPENED', 'CLOSED']);


status.OPENED; // { name: 'OPENED', order: 0, ortherInfo: 'status open' }

status.getByOrder(1); // { name: 'OPENED', order: 0, ortherInfo: 'status open'}

status.OPENED.eql('OPENED') // true

APIs

  • eql

compare with enum

  • getByOrder

return the enum by order

some tips

  • init order

order only can init in first position of the array, and order is increased by step 1.

var status = enum([
  {
    name: 'CLOSED',
    order: 2
  },
  {
    name: 'OPENED',
  }
]);


status.OPENED.order; // 3
  • custom eql
var status = enum(['OPENED', 'CLOSED']);

status.OPENED.eql('OPENED') // true, eql by name, param must be string

status.OPENED.eql(0) // true, eql by order, param should not be NaN

status.OPENED.eql({name: 'OPENED'}) // true

status.OPENED.eql({name: 'OPENED', order: 2}) // false

status.OPENED.eql({name: 'OPENED', order: 1, ortherInfo: 'status open'}) // true

js-enums's People

Contributors

forthedamn avatar

Stargazers

 avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

Forkers

qjwxtm

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.