10000 change action name for on and once · TYPECASTINGSG/rpscript-api-basic@0a0ab5b · GitHub
[go: up one dir, main page]

Skip to content

Commit 0a0ab5b

Browse files
committed
change action name for on and once
1 parent 730a0a5 commit 0a0ab5b

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

src/index.ts

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -97,10 +97,10 @@ export default class RPSBasic {
9797
}
9898

9999
/**
100-
* @function once
100+
* @function listen-once
101101
* @memberof Basic
102102
* @example
103-
* once 'connected' $emitter
103+
* listen-once 'connected' $emitter
104104
*
105105
* @param {EventEmitter} event The object to listen to.
106106
* @param {string} eventName Name to listen for event.
@@ -110,18 +110,18 @@ export default class RPSBasic {
110110
* @see {@link https://nodejs.org/api/events.html#events_emitter_once_eventname_listener}
111111
*
112112
*/
113-
@rpsAction({verbName:'once'})
113+
@rpsAction({verbName:'listen-once'})
114114
once (ctx:RpsContext,opts:{}, event:EventEmitter, evtName:string) : Promise<any>{
115115
return new Promise(function(resolve) {
116116
event.once(evtName, (...params) => resolve(params));
117117
});
118118
}
119119

120120
/**
121-
* @function on
121+
* @function listen-on
122122
* @memberof Basic
123123
* @example
124-
* on $emitter 'start' @ $output { console-log $output }
124+
* listen-on $emitter 'start' @ $output { console-log $output }
125125
*
126126
* @param {EventEmitter} event The object to listen to.
127127
* @param {string} eventName Name to listen for event.
@@ -131,7 +131,7 @@ export default class RPSBasic {
131131
* @see {@link https://nodejs.org/api/events.html#events_emitter_once_eventname_listener}
132132
*
133133
*/
134-
@rpsAction({verbName:'on'})
134+
@rpsAction({verbName:'listen-on'})
135135
async on (ctx:RpsContext,opts:{}, event:EventEmitter, evtName:string, cb:(any)=>void) : Promise<EventEmitter>{
136136
event.on(evtName, (...params) => cb(params));
137137
return event;

0 commit comments

Comments
 (0)
0