Code Monkey home page Code Monkey logo

z's Introduction

z Native pattern matching for Javascript.

Build Status Coverage Status Dependency Status NPM version

Usage

  • Install via npm: npm install z
  • Require z in your code and use the matches function: const { matches } = require('z')

Avaiable Patterns

  • Matches by value: (x = 1) =>, (x = null) =>, (x = 'true') =>
  • Matches by object or array: (x = {a: 1}) =>, (x = [1, 2]) =>
  • Matches by type: (x = String) =>, (x = Boolean) =>
  • Matches by instance: (x = Date) =>, (x = Person) =>
  • Matches by spiting array into elements and tail (head, tail) => , (a, b, c, tail) =>, etc…

Examples

  • Example: Matches by Object property
const { matches } = require('z')

const person = { name: 'Maria' }
matches(person)(
  (x = { name: 'John' }) => console.log('John you are not welcome!'),
  (x)                    => console.log(`Hey ${x.name}, you are welcome!`)
)

//output: `Hey Maria, you are welcome!`
  • Example: Matches by type or instances
const { matches } = require('z')

const result = matches(1)(
  (x = 2)      => 'number 2 is the best!!!',
  (x = Number) => `number ${x} is not that good`,
  (x = Date)   => 'blaa.. dates are awful!'
)

console.log(result) // output: number 1 is not that good
  • Example: matches Array content

To match array content you need create multiple arguments for the match function, such as (a, b, c, tail) => {} , then each variable match each item from array. Note: last variable contains all remaining array items, formally named tail. Examples:

const { matches } = require('z')

matches([1, 2, 3, 4, 5])(
  (a, b, c, tail) => 'a = 1, b = 2, c = 3, tail = [4, 5]'  
)

matches([1, 2])(
  (a, tail) => 'a = 1, b = [2]'  
)

matches([1])(
  (a, b,  tail)       => 'Will not match here',
  (a = 2, tail = [])  => 'Will not match here',
  (a = 1, tail = [])  => 'Will match here, b = []'
)
  • Example: Powerful recursive code which will remove sequential repeated items from Array.

Can be mind blowing if it’s the first time you meet pattern matching, but you are gonna understand it!

const { matches } = require('z')

const compress = (numbers) => {
  return matches(numbers)(
    (x, y, xs) => x === y
      ? compress([x].concat(xs))
      : [x].concat(compress([y].concat(xs))),
    (x, xs) => x // stopping condition
  )
}

compress([1, 1, 2, 3, 4, 4, 4]) //output: [1, 2, 3]

License

Apache 2.0

z's People

Contributors

leonardiwagner avatar paulojean avatar bysabi avatar koleok avatar pvorona avatar

Watchers

James Cloos avatar  avatar

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.