Git Product home page Git Product logo

metho's Introduction

Metho - A new method for methods

A small library to allow you to safely add 'dynamic properties' to objects, with the help of Symbols. This is useful for 'monkey patching' native JavaScript types to give them new capabilities. Some examples:

import * as Metho from 'metho'

const asHex = Metho.add(
  Number.prototype,
  function() { return this.toString(16) }
)

console.log(65534[asHex])  // fffe

const upper = Metho.add(
  String.prototype,
  function() { return this.toUpperCase() }
)
const chunk = Metho.add(
  String.prototype,
  function(length) {
    return this.match(new RegExp('.{1,' + length + '}', 'g'))
  }
)

console.log("Hello World!"[upper][chunk(2)])  // ['HE', 'LL', 'O ', 'WO', 'RL', 'D!']

How to use

Metho is fairly simple, and offers 4 basic functions for adding these 'dynamic properties' to your target object. All functions will return either a Symbol, or a function that returns a Symbol. These Symbols are the property 'names'.

add(target, function, [outerSyntax = false])

This is probably the function you'll need most often. It will use from addWithParams or addSimple based on the arity of the passed function - an arity of 0 will cause addSimple to be used, anything else will cause addWithParams or addProperty to be used - based upon the state of outerSyntax. When added with outerSyntax set to true - the syntax for your property will be that of a more regular function call:

// outerSyntax = false
object[property(x)]

// outerSyntax = true
object[property](x)

There is a slight performance hit when not using outerSyntax - hence the reason for the switch.

addWithParams(target, function)

Adds a 'dynamic property` that can accept parameters

console.log(object[property(param1, param2)]

addSimple(target, function)

Adds a 'dynamic property` that has no parameters

console.log(object[property])

addProperty(target, propertyValue)

Adds a regular property to the target (will not be automatically called if it is a function)

console.log(object[property])

metho's People

Contributors

jonrandy avatar

Watchers

 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.