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
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
|
# call-signature [](https://travis-ci.org/jamestalmage/call-signature)
> Parse / Generate Method Signatures
## Install
```
$ npm install --save call-signature
```
## Usage
```js
var signature = require('call-signature');
// parse a call signature definition
var parsed = signature.parse('t.equal(expected, actual, [message])');
console.log(parsed);
/* =>
{
callee: {
type: 'MemberExpression',
object: 't',
member: 'equal'
},
args: [
{
name: 'actual',
optional: false
},
{
name: 'expected',
optional: false
},
{
name: 'message',
optional: true
}
]
}
*/
// Create signature definitions from the parsed object.
signature.generate(parsed);
//=> "t.equal(expected, actual, [message])"
```
## API
### callSignature.parse(input)
#### input
Type: `string`
A string that matches the call signature spec:
`object.member(required_arg1, required_arg2, [optional_arg1])`
`name(required_arg1, required_arg2, [optional_arg1])`
`object`, `member` and `name` can be any identifiers, but currently the callee must be a `MemberExpression` or an `Identifier` (that requirement may loosen in the future).
You can have any number of arguments. Optional arguments are denoted by placing the argument name between square `[`brackets`]`.
#### returns
A simple JS Object with three properties `callee` and `args`.
`callee` will be an object containing `type` property and its corresponding properties.
when matched against `MemberExpression` like `foo.bar(baz)`, `object` and `member` will be strings.
callee: {
type: 'MemberExpression',
object: 'foo',
member: 'bar'
}
when matched against `Identifier` like `foo(baz)`, `name` will be string.
callee: {
type: 'Identifier',
name: 'foo'
}
`args` will be an array. Each item of the array will have two properties `name`, and `optional`.
`name` will be the `string` name of the arg. `optional` will be a boolean value.
### callSignature.generate(parsed)
#### input
Type: `Object`
Must have the same definition as the return value from the `parse` method.
#### returns
A `string` signature definition that will parse to exactly the provided input.
## Related
- [escallmatch](https://www.npmjs.com/package/escallmatch) - Similar, with compatible string definitions to this library. Can be used to match AST Nodes to parsed signatures.
## License
MIT © [James Talmage](http://github.com/jamestalmage)
|
