Skip to content
This repository was archived by the owner on Jan 9, 2020. It is now read-only.

Commit 40b5495

Browse files
committed
doc(readme): sync api
1 parent 050e76d commit 40b5495

2 files changed

Lines changed: 10 additions & 4 deletions

File tree

README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,17 +49,21 @@ Returns **[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/G
4949

5050
### endpointParentSeparator
5151

52-
Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** separator between step name and endpoint name
52+
separator between step name and endpoint name
53+
54+
Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** '/'
5355

5456
### log
5557

56-
adds 'step-type' and 'step-name'
58+
adds 'step-type' and 'step-name' to the log event
5759

5860
**Parameters**
5961

6062
- `level`
6163
- `arg`
6264

65+
Returns **[undefined](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined)**
66+
6367
### name
6468

6569
Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 'kronos-step'

src/step.js

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,14 +34,16 @@ export class Step extends Service {
3434
}
3535

3636
/**
37-
* @return {string} separator between step name and endpoint name
37+
* separator between step name and endpoint name
38+
* @return {string} '/'
3839
**/
3940
get endpointParentSeparator() {
4041
return '/';
4142
}
4243

4344
/**
44-
* adds 'step-type' and 'step-name'
45+
* adds 'step-type' and 'step-name' to the log event
46+
* @return {undefined}
4547
**/
4648
log(level, arg) {
4749
this.endpoints.log.receive(

0 commit comments

Comments
 (0)