UNPKG

@daysnap/utils

Version:

通用的工具库

github.com/daysnap/utils

daysnap/utils

152 lines (82 loc) • 2.5 kB
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
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
[@daysnap/utils](../README.md) / [Exports](../modules.md) / Poller # Class: Poller ## Table of contents ### Constructors - [constructor](Poller.md#constructor) ### Properties - [count](Poller.md#count) - [currentCount](Poller.md#currentcount) - [options](Poller.md#options) - [task](Poller.md#task) ### Accessors - [isRunning](Poller.md#isrunning) ### Methods - [run](Poller.md#run) - [start](Poller.md#start) - [stop](Poller.md#stop) ## Constructors ### constructor • **new Poller**(`task`, `options?`) #### Parameters | Name | Type | | :------ | :------ | | `task` | [`PollerTask`](../modules.md#pollertask) | | `options` | `Partial`<[`PollerOptions`](../interfaces/PollerOptions.md)\> | #### Defined in [poller.ts:23](https://github.com/daysnap/utils/blob/585cbee/src/poller.ts#L23) ## Properties ### count • `Private` **count**: `number` = `0` #### Defined in [poller.ts:14](https://github.com/daysnap/utils/blob/585cbee/src/poller.ts#L14) ___ ### currentCount • `Private` **currentCount**: `number` = `-1` #### Defined in [poller.ts:17](https://github.com/daysnap/utils/blob/585cbee/src/poller.ts#L17) ___ ### options • `Private` **options**: [`PollerOptions`](../interfaces/PollerOptions.md) #### Defined in [poller.ts:16](https://github.com/daysnap/utils/blob/585cbee/src/poller.ts#L16) ___ ### task • `Private` **task**: [`PollerTask`](../modules.md#pollertask) #### Defined in [poller.ts:15](https://github.com/daysnap/utils/blob/585cbee/src/poller.ts#L15) ## Accessors ### isRunning • `get` **isRunning**(): `boolean` #### Returns `boolean` #### Defined in [poller.ts:19](https://github.com/daysnap/utils/blob/585cbee/src/poller.ts#L19) ## Methods ### run ▸ `Private` **run**(`count`): `Promise`<`void`\> #### Parameters | Name | Type | | :------ | :------ | | `count` | `number` | #### Returns `Promise`<`void`\> #### Defined in [poller.ts:28](https://github.com/daysnap/utils/blob/585cbee/src/poller.ts#L28) ___ ### start ▸ **start**(`forceUpdate?`): [`Poller`](Poller.md) #### Parameters | Name | Type | Default value | | :------ | :------ | :------ | | `forceUpdate` | `boolean` | `true` | #### Returns [`Poller`](Poller.md) #### Defined in [poller.ts:46](https://github.com/daysnap/utils/blob/585cbee/src/poller.ts#L46) ___ ### stop ▸ **stop**(): [`Poller`](Poller.md) #### Returns [`Poller`](Poller.md) #### Defined in [poller.ts:41](https://github.com/daysnap/utils/blob/585cbee/src/poller.ts#L41)