Skip to content

Commit 7f61e82

Browse files
committed
update documents
1 parent e22d560 commit 7f61e82

1 file changed

Lines changed: 8 additions & 2 deletions

File tree

src/index.ts

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,11 @@ type parse_arg =
3636
| arg_bytes
3737
| arg_BN
3838

39+
/**
40+
parse an existing flake,
41+
@param arg parse arg, see documentation
42+
@see [available arguments](https://github.com/zzzz465/timeflake4js#example)
43+
*/
3944
export function parse(arg: parse_arg): Timeflake {
4045
let res: BN | undefined = undefined
4146
switch (arg.type) {
@@ -69,7 +74,8 @@ export function parse(arg: parse_arg): Timeflake {
6974
const getTime = timer()
7075

7176
/**
72-
*
77+
* generates random timeflake
78+
* @returns Timeflake instance
7379
*/
7480
export function random() {
7581
const timestamp = getTime()
@@ -80,7 +86,7 @@ export function random() {
8086
}
8187

8288
/**
83-
*
89+
* generate timeflake from given values
8490
* @param timestamp
8591
* @param random
8692
*/

0 commit comments

Comments
 (0)