@j13b/react-state 0.1.0

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 (91) hide show
  1. package/LICENSE +201 -0
  2. package/NOTICE +16 -0
  3. package/README.md +60 -0
  4. package/dist/cjs/hooks/use_runner_error.d.ts +25 -0
  5. package/dist/cjs/hooks/use_runner_error.js +30 -0
  6. package/dist/cjs/hooks/use_runner_error_effect.d.ts +28 -0
  7. package/dist/cjs/hooks/use_runner_error_effect.js +35 -0
  8. package/dist/cjs/hooks/use_runner_feedback.d.ts +26 -0
  9. package/dist/cjs/hooks/use_runner_feedback.js +31 -0
  10. package/dist/cjs/hooks/use_runner_feedback_effect.d.ts +30 -0
  11. package/dist/cjs/hooks/use_runner_feedback_effect.js +37 -0
  12. package/dist/cjs/hooks/use_runner_progress.d.ts +21 -0
  13. package/dist/cjs/hooks/use_runner_progress.js +7 -0
  14. package/dist/cjs/hooks/use_runner_progress_effect.d.ts +31 -0
  15. package/dist/cjs/hooks/use_runner_progress_effect.js +38 -0
  16. package/dist/cjs/hooks/use_runner_status.d.ts +23 -0
  17. package/dist/cjs/hooks/use_runner_status.js +28 -0
  18. package/dist/cjs/hooks/use_runner_status_effect.d.ts +24 -0
  19. package/dist/cjs/hooks/use_runner_status_effect.js +31 -0
  20. package/dist/cjs/hooks/use_signal_value.d.ts +38 -0
  21. package/dist/cjs/hooks/use_signal_value.js +56 -0
  22. package/dist/cjs/hooks/use_signal_value_effect.d.ts +34 -0
  23. package/dist/cjs/hooks/use_signal_value_effect.js +60 -0
  24. package/dist/cjs/hooks/use_update.d.ts +14 -0
  25. package/dist/cjs/hooks/use_update.js +23 -0
  26. package/dist/cjs/index.d.ts +21 -0
  27. package/dist/cjs/index.js +37 -0
  28. package/dist/cjs/package.json +3 -0
  29. package/dist/hooks/use_runner_error.d.ts +26 -0
  30. package/dist/hooks/use_runner_error.d.ts.map +1 -0
  31. package/dist/hooks/use_runner_error.js +32 -0
  32. package/dist/hooks/use_runner_error.js.map +1 -0
  33. package/dist/hooks/use_runner_error_effect.d.ts +29 -0
  34. package/dist/hooks/use_runner_error_effect.d.ts.map +1 -0
  35. package/dist/hooks/use_runner_error_effect.js +37 -0
  36. package/dist/hooks/use_runner_error_effect.js.map +1 -0
  37. package/dist/hooks/use_runner_feedback.d.ts +21 -0
  38. package/dist/hooks/use_runner_feedback.d.ts.map +1 -0
  39. package/dist/hooks/use_runner_feedback.js +27 -0
  40. package/dist/hooks/use_runner_feedback.js.map +1 -0
  41. package/dist/hooks/use_runner_feedback_effect.d.ts +25 -0
  42. package/dist/hooks/use_runner_feedback_effect.d.ts.map +1 -0
  43. package/dist/hooks/use_runner_feedback_effect.js +33 -0
  44. package/dist/hooks/use_runner_feedback_effect.js.map +1 -0
  45. package/dist/hooks/use_runner_progress.d.ts +3 -0
  46. package/dist/hooks/use_runner_progress.d.ts.map +1 -0
  47. package/dist/hooks/use_runner_progress.js +9 -0
  48. package/dist/hooks/use_runner_progress.js.map +1 -0
  49. package/dist/hooks/use_runner_progress_effect.d.ts +26 -0
  50. package/dist/hooks/use_runner_progress_effect.d.ts.map +1 -0
  51. package/dist/hooks/use_runner_progress_effect.js +34 -0
  52. package/dist/hooks/use_runner_progress_effect.js.map +1 -0
  53. package/dist/hooks/use_runner_status.d.ts +24 -0
  54. package/dist/hooks/use_runner_status.d.ts.map +1 -0
  55. package/dist/hooks/use_runner_status.js +30 -0
  56. package/dist/hooks/use_runner_status.js.map +1 -0
  57. package/dist/hooks/use_runner_status_effect.d.ts +25 -0
  58. package/dist/hooks/use_runner_status_effect.d.ts.map +1 -0
  59. package/dist/hooks/use_runner_status_effect.js +33 -0
  60. package/dist/hooks/use_runner_status_effect.js.map +1 -0
  61. package/dist/hooks/use_signal_value.d.ts +39 -0
  62. package/dist/hooks/use_signal_value.d.ts.map +1 -0
  63. package/dist/hooks/use_signal_value.js +51 -0
  64. package/dist/hooks/use_signal_value.js.map +1 -0
  65. package/dist/hooks/use_signal_value_effect.d.ts +35 -0
  66. package/dist/hooks/use_signal_value_effect.d.ts.map +1 -0
  67. package/dist/hooks/use_signal_value_effect.js +54 -0
  68. package/dist/hooks/use_signal_value_effect.js.map +1 -0
  69. package/dist/hooks/use_update.d.ts +15 -0
  70. package/dist/hooks/use_update.d.ts.map +1 -0
  71. package/dist/hooks/use_update.js +24 -0
  72. package/dist/hooks/use_update.js.map +1 -0
  73. package/dist/index.d.ts +22 -0
  74. package/dist/index.d.ts.map +1 -0
  75. package/dist/index.js +12 -0
  76. package/package.json +79 -0
  77. package/src/__tests__/exports.test.ts +32 -0
  78. package/src/__tests__/hooks.test.tsx +242 -0
  79. package/src/hooks/use_runner_error.ts +29 -0
  80. package/src/hooks/use_runner_error_effect.ts +37 -0
  81. package/src/hooks/use_runner_feedback.ts +31 -0
  82. package/src/hooks/use_runner_feedback_effect.ts +40 -0
  83. package/src/hooks/use_runner_progress.ts +25 -0
  84. package/src/hooks/use_runner_progress_effect.ts +41 -0
  85. package/src/hooks/use_runner_status.ts +27 -0
  86. package/src/hooks/use_runner_status_effect.ts +33 -0
  87. package/src/hooks/use_signal_value.ts +61 -0
  88. package/src/hooks/use_signal_value_effect.ts +68 -0
  89. package/src/hooks/use_update.ts +21 -0
  90. package/src/index.ts +21 -0
  91. package/tsconfig.json +23 -0
@@ -0,0 +1,21 @@
1
+ import { useReducer } from 'react';
2
+
3
+ const updateReducer = (num: number): number => (num + 1) % 1_000_000;
4
+
5
+ /**
6
+ * A hook that provides a way to force component re-renders.
7
+ *
8
+ * @returns A function that triggers a re-render when called
9
+ *
10
+ * @example
11
+ * ```tsx
12
+ * const update = useUpdate();
13
+ *
14
+ * // Force a re-render
15
+ * update();
16
+ * ```
17
+ */
18
+ export const useUpdate = () => {
19
+ const [, update] = useReducer(updateReducer, 0);
20
+ return update as () => void;
21
+ };
package/src/index.ts ADDED
@@ -0,0 +1,21 @@
1
+ /**
2
+ * React bindings for @j13b/state.
3
+ * Hooks for subscribing to Signals, Runners, and Broadcasts from React
4
+ * components. Requires react and @j13b/state as peer dependencies.
5
+ *
6
+ * @example
7
+ * ```typescript
8
+ * import { useSignalValue, useRunnerStatus } from '@j13b/react-state';
9
+ * ```
10
+ */
11
+ export * from './hooks/use_signal_value.js';
12
+ export * from './hooks/use_signal_value_effect.js';
13
+ export * from './hooks/use_update.js';
14
+ export * from './hooks/use_runner_status.js';
15
+ export * from './hooks/use_runner_status_effect.js';
16
+ export * from './hooks/use_runner_error.js';
17
+ export * from './hooks/use_runner_error_effect.js';
18
+ export * from './hooks/use_runner_progress.js';
19
+ export * from './hooks/use_runner_progress_effect.js';
20
+ export * from './hooks/use_runner_feedback.js';
21
+ export * from './hooks/use_runner_feedback_effect.js';
package/tsconfig.json ADDED
@@ -0,0 +1,23 @@
1
+ {
2
+ "compilerOptions": {
3
+ "target": "ES2022",
4
+ "module": "ESNext",
5
+ "moduleResolution": "Bundler",
6
+ "lib": ["ES2022", "DOM", "DOM.Iterable"],
7
+ "jsx": "react-jsx",
8
+ "strict": true,
9
+ "noImplicitAny": false,
10
+ "esModuleInterop": true,
11
+ "skipLibCheck": true,
12
+ "forceConsistentCasingInFileNames": true,
13
+ "isolatedModules": true,
14
+ "resolveJsonModule": true,
15
+ "declaration": true,
16
+ "declarationMap": true,
17
+ "sourceMap": true,
18
+ "outDir": "./dist",
19
+ "rootDir": "./src"
20
+ },
21
+ "include": ["src/**/*"],
22
+ "exclude": ["node_modules", "dist", "**/*.test.ts", "**/*.test.tsx", "**/__tests__/**"]
23
+ }