@hyperix/hooks 0.1.0

package/README.md

@@ -0,0 +1,27 @@
+# @bunstack/hooks
+
+React hooks for the local workspace.
+
+## Workspace usage
+
+This package is intended for source-first usage inside the monorepo. Consumers should reference it with `"workspace:*"` and let the app bundler resolve the TypeScript source.
+
+## Example
+
+```tsx
+import { useState } from "react";
+import { useDebouncedValue } from "@bunstack/hooks";
+
+function Search() {
+  const [query, setQuery] = useState("");
+  const debouncedQuery = useDebouncedValue(query, 300);
+
+  return <input value={query} onChange={(e) => setQuery(e.target.value)} />;
+}
+```
+
+## Tests
+
+```bash
+bun run --cwd packages/hooks test
+```

package/dist/index.d.ts

@@ -0,0 +1,17 @@
+import * as _outofgas_react_stream from '@outofgas/react-stream';
+
+declare function useDebouncedValue<T>(value: T, delayMs?: number): T;
+
+type L2BookLevel = [price: number, size: number, cumulativeSize: number];
+type L2Book = {
+    bids: L2BookLevel[];
+    asks: L2BookLevel[];
+    maxCumulativeSize: number;
+};
+type UseL2BookOptions = {
+    depth?: number;
+    nSigFigs?: number;
+};
+declare const useL2Book: (coin: string, options?: UseL2BookOptions) => _outofgas_react_stream.UseSubscribeState<L2Book>;
+
+export { type L2Book, type L2BookLevel, type UseL2BookOptions, useDebouncedValue, useL2Book };