Blame view

node_modules/delegates/Readme.md 1.73 KB
aaac7fed   liuqimichale   add
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
  
  # 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#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