@usefy/use-timer 0.0.25 → 0.0.27

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +33 -39
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -1,5 +1,5 @@
1
1
  <p align="center">
2
- <img src="https://raw.githubusercontent.com/geon0529/usefy/master/assets/logo.png" alt="usefy logo" width="120" />
2
+ <img src="https://raw.githubusercontent.com/mirunamu00/usefy/master/assets/logo.png" alt="usefy logo" width="120" />
3
3
  </p>
4
4
 
5
5
  <h1 align="center">@usefy/use-timer</h1>
@@ -18,7 +18,7 @@
18
18
  <a href="https://bundlephobia.com/package/@usefy/use-timer">
19
19
  <img src="https://img.shields.io/bundlephobia/minzip/@usefy/use-timer?style=flat-square&color=007acc" alt="bundle size" />
20
20
  </a>
21
- <a href="https://github.com/geon0529/usefy/blob/master/LICENSE">
21
+ <a href="https://github.com/mirunamu00/usefy/blob/master/LICENSE">
22
22
  <img src="https://img.shields.io/npm/l/@usefy/use-timer.svg?style=flat-square&color=007acc" alt="license" />
23
23
  </a>
24
24
  </p>
@@ -32,7 +32,7 @@
32
32
  </p>
33
33
 
34
34
  <p align="center">
35
- <a href="https://geon0529.github.io/usefy/?path=/docs/hooks-usetimer--docs" target="_blank" rel="noopener noreferrer">
35
+ <a href="https://mirunamu00.github.io/usefy/?path=/docs/hooks-usetimer--docs" target="_blank" rel="noopener noreferrer">
36
36
  <strong>📚 View Storybook Demo</strong>
37
37
  </a>
38
38
  </p>
@@ -97,7 +97,7 @@ function Timer() {
97
97
 
98
98
  return (
99
99
  <div>
100
- <p>{timer.formattedTime}</p>
100
+ <p>{timer.time}</p>
101
101
  <button onClick={timer.toggle}>
102
102
  {timer.isRunning ? "Pause" : "Start"}
103
103
  </button>
@@ -151,30 +151,24 @@ A hook that manages countdown timer state with comprehensive controls.
151
151
 
152
152
  #### Returns `UseTimerReturn`
153
153
 
154
- | Property | Type | Description |
155
- | --------------- | ---------------------- | ------------------------------------------------------- |
156
- | `time` | `number` | Current remaining time in milliseconds |
157
- | `initialTime` | `number` | Initial time value |
158
- | `formattedTime` | `string` | Formatted time string |
159
- | `progress` | `number` | Progress percentage (0-100) |
160
- | `status` | `TimerStatus` | Current status: `idle`, `running`, `paused`, `finished` |
161
- | `isRunning` | `boolean` | Whether timer is running |
162
- | `isPaused` | `boolean` | Whether timer is paused |
163
- | `isFinished` | `boolean` | Whether timer has finished |
164
- | `isIdle` | `boolean` | Whether timer is idle |
165
- | `hours` | `number` | Decomposed hours component |
166
- | `minutes` | `number` | Decomposed minutes component |
167
- | `seconds` | `number` | Decomposed seconds component |
168
- | `milliseconds` | `number` | Decomposed milliseconds component |
169
- | `start` | `() => void` | Start the timer |
170
- | `pause` | `() => void` | Pause the timer |
171
- | `stop` | `() => void` | Stop timer (keep current time) |
172
- | `reset` | `() => void` | Reset to initial time |
173
- | `restart` | `() => void` | Reset and immediately start |
174
- | `toggle` | `() => void` | Toggle between start/pause |
175
- | `addTime` | `(ms: number) => void` | Add time to the timer |
176
- | `subtractTime` | `(ms: number) => void` | Subtract time from the timer |
177
- | `setTime` | `(ms: number) => void` | Set timer to a specific value |
154
+ | Property | Type | Description |
155
+ | -------------- | ---------------------- | ------------------------------------------------------- |
156
+ | `time` | `string` | Formatted time string (e.g., "05:30") |
157
+ | `progress` | `number` | Progress percentage (0-100) |
158
+ | `status` | `TimerStatus` | Current status: `idle`, `running`, `paused`, `finished` |
159
+ | `isRunning` | `boolean` | Whether timer is running |
160
+ | `isPaused` | `boolean` | Whether timer is paused |
161
+ | `isFinished` | `boolean` | Whether timer has finished |
162
+ | `isIdle` | `boolean` | Whether timer is idle |
163
+ | `start` | `() => void` | Start the timer |
164
+ | `pause` | `() => void` | Pause the timer |
165
+ | `stop` | `() => void` | Stop timer (keep current time) |
166
+ | `reset` | `() => void` | Reset to initial time |
167
+ | `restart` | `() => void` | Reset and immediately start |
168
+ | `toggle` | `() => void` | Toggle between start/pause |
169
+ | `addTime` | `(ms: number) => void` | Add time to the timer |
170
+ | `subtractTime` | `(ms: number) => void` | Subtract time from the timer |
171
+ | `setTime` | `(ms: number) => void` | Set timer to a specific value |
178
172
 
179
173
  ### `ms` Helper Object
180
174
 
@@ -208,7 +202,7 @@ function CountdownTimer() {
208
202
 
209
203
  return (
210
204
  <div>
211
- <div className="time-display">{timer.formattedTime}</div>
205
+ <div className="time-display">{timer.time}</div>
212
206
  <div className="controls">
213
207
  <button onClick={timer.toggle}>
214
208
  {timer.isRunning ? "⏸ Pause" : "▶ Start"}
@@ -233,7 +227,7 @@ function PrecisionTimer() {
233
227
 
234
228
  return (
235
229
  <div>
236
- <div className="precision-display">{timer.formattedTime}</div>
230
+ <div className="precision-display">{timer.time}</div>
237
231
  <button onClick={timer.toggle}>
238
232
  {timer.isRunning ? "Pause" : "Start"}
239
233
  </button>
@@ -254,7 +248,7 @@ function AutoStartTimer() {
254
248
  onComplete: () => console.log("Completed!"),
255
249
  });
256
250
 
257
- return <div>{timer.formattedTime}</div>;
251
+ return <div>{timer.time}</div>;
258
252
  }
259
253
  ```
260
254
 
@@ -272,7 +266,7 @@ function LoopingTimer() {
272
266
 
273
267
  return (
274
268
  <div>
275
- <p>{timer.formattedTime}</p>
269
+ <p>{timer.time}</p>
276
270
  <button onClick={timer.toggle}>
277
271
  {timer.isRunning ? "Pause" : "Start"}
278
272
  </button>
@@ -291,7 +285,7 @@ function ManipulableTimer() {
291
285
 
292
286
  return (
293
287
  <div>
294
- <p>{timer.formattedTime}</p>
288
+ <p>{timer.time}</p>
295
289
  <div className="controls">
296
290
  <button onClick={timer.toggle}>
297
291
  {timer.isRunning ? "Pause" : "Start"}
@@ -315,7 +309,7 @@ function TimerWithProgress() {
315
309
 
316
310
  return (
317
311
  <div>
318
- <p>{timer.formattedTime}</p>
312
+ <p>{timer.time}</p>
319
313
  <div className="progress-bar">
320
314
  <div
321
315
  className="progress-fill"
@@ -347,7 +341,7 @@ function CustomFormattedTimer() {
347
341
 
348
342
  return (
349
343
  <div>
350
- <p>{timer.formattedTime}</p> {/* "2h 30m 0s" */}
344
+ <p>{timer.time}</p> {/* "2h 30m 0s" */}
351
345
  <button onClick={timer.toggle}>
352
346
  {timer.isRunning ? "Pause" : "Start"}
353
347
  </button>
@@ -378,7 +372,7 @@ function KitchenTimer() {
378
372
  </button>
379
373
  ))}
380
374
  </div>
381
- <p>{timer.formattedTime}</p>
375
+ <p>{timer.time}</p>
382
376
  <button onClick={timer.toggle}>
383
377
  {timer.isRunning ? "Pause" : "Start"}
384
378
  </button>
@@ -456,7 +450,7 @@ This package maintains comprehensive test coverage to ensure reliability and sta
456
450
 
457
451
  ### Test Coverage
458
452
 
459
- 📊 <a href="https://geon0529.github.io/usefy/coverage/use-timer/src/index.html" target="_blank" rel="noopener noreferrer"><strong>View Detailed Coverage Report</strong></a> (GitHub Pages)
453
+ 📊 <a href="https://mirunamu00.github.io/usefy/coverage/use-timer/src/index.html" target="_blank" rel="noopener noreferrer"><strong>View Detailed Coverage Report</strong></a> (GitHub Pages)
460
454
 
461
455
  ### Test Files
462
456
 
@@ -483,9 +477,9 @@ pnpm test --coverage
483
477
 
484
478
  ## License
485
479
 
486
- MIT © [mirunamu](https://github.com/geon0529)
480
+ MIT © [mirunamu](https://github.com/mirunamu00)
487
481
 
488
- This package is part of the [usefy](https://github.com/geon0529/usefy) monorepo.
482
+ This package is part of the [usefy](https://github.com/mirunamu00/usefy) monorepo.
489
483
 
490
484
  ---
491
485
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@usefy/use-timer",
3
- "version": "0.0.25",
3
+ "version": "0.0.27",
4
4
  "description": "A React hook for managing countdown timers with precision and control",
5
5
  "main": "./dist/index.js",
6
6
  "module": "./dist/index.mjs",
@@ -35,7 +35,7 @@
35
35
  },
36
36
  "repository": {
37
37
  "type": "git",
38
- "url": "https://github.com/geon0529/usefy.git",
38
+ "url": "https://github.com/mirunamu00/usefy.git",
39
39
  "directory": "packages/use-timer"
40
40
  },
41
41
  "license": "MIT",