https://github.com/tj/node-delegates

Nodejs method and accessor delegation utility
https://github.com/tj/node-delegates

Last synced: 12 days ago
JSON representation

Nodejs method and accessor delegation utility

• Host: GitHub
• URL: https://github.com/tj/node-delegates
• Owner: tj
• License: mit
• Created: 2014-01-13T14:20:04.000Z (almost 11 years ago)
• Default Branch: master
• Last Pushed: 2020-02-25T14:04:19.000Z (over 4 years ago)
• Last Synced: 2024-10-29T14:18:32.496Z (13 days ago)
• Language: JavaScript
• Size: 16.6 KB
• Stars: 432
• Watchers: 6
• Forks: 56
• Open Issues: 11
• Metadata Files:
  • Readme: Readme.md
  • Changelog: History.md
  • License: License

Awesome Lists containing this project

README

        

# delegates

  Node method and accessor delegation utilty.

## Installation

```

$ npm install delegates

```

## Example

```js

var delegate = require('delegates');

...

delegate(proto, 'request')

  .method('acceptsLanguages')

  .method('acceptsEncodings')

  .method('acceptsCharsets')

  .method('accepts')

  .method('is')

  .access('querystring')

  .access('idempotent')

  .access('socket')

  .access('length')

  .access('query')

  .access('search')

  .access('status')

  .access('method')

  .access('path')

  .access('body')

  .access('host')

  .access('url')

  .getter('subdomains')

  .getter('protocol')

  .getter('header')

  .getter('stale')

  .getter('fresh')

  .getter('secure')

  .getter('ips')

  .getter('ip')

```

# API

## Delegate(proto, prop)

Creates a delegator instance used to configure using the `prop` on the given

`proto` object. (which is usually a prototype)

## Delegate.auto(proto, targetProto, targetProp)

Delegates getters, setters, values, and methods from targetProto to proto.

Assumes that targetProto objects will exist under proto objects with the key targetProp.

## Delegate#method(name)

Allows the given method `name` to be accessed on the host.

## Delegate#getter(name)

Creates a "getter" for the property with the given `name` on the delegated

object.

## Delegate#setter(name)

Creates a "setter" for the property with the given `name` on the delegated

object.

## Delegate#access(name)

Creates an "accessor" (ie: both getter *and* setter) for the property with the

given `name` on the delegated object.

## Delegate#fluent(name)

A unique type of "accessor" that works for a "fluent" API. When called as a

getter, the method returns the expected value. However, if the method is called

with a value, it will return itself so it can be chained. For example:

```js

delegate(proto, 'request')

  .fluent('query')

// getter

var q = request.query();

// setter (chainable)

request

  .query({ a: 1 })

  .query({ b: 2 });

```

# License

  MIT