Mirror/brk
1
0
Fork 0
mirror of https://github.com/bitcoinresearchkit/brk.git synced 2026-04-24 14:49:58 -07:00
Code Issues Packages Projects Releases Wiki Activity

docs: update generated docs

Browse Source
This commit is contained in:
nym21
2026-03-23 16:45:58 +01:00
parent c4c0004c4a
commit 0d2deb1b63
780 changed files with 23664 additions and 18747 deletions
Download Patch File Download Diff File Expand all files Collapse all files

49
modules/brk-client/docs/interfaces/SeriesLeafWithSchema.md Normal file
View File

@@ -0,0 +1,49 @@
[**brk-client**](../README.md)
***
[brk-client](../globals.md) / SeriesLeafWithSchema
# Interface: SeriesLeafWithSchema
Defined in: [Developer/brk/modules/brk-client/index.js:721](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L721)
## Properties
### indexes
> **indexes**: [`Index`](../type-aliases/Index.md)[]
Defined in: [Developer/brk/modules/brk-client/index.js:724](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L724)
Available indexes for this series
***
### kind
> **kind**: `string`
Defined in: [Developer/brk/modules/brk-client/index.js:723](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L723)
The Rust type (e.g., "Sats", "StoredF64")
***
### name
> **name**: `string`
Defined in: [Developer/brk/modules/brk-client/index.js:722](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L722)
The series name/identifier
***
### type
> **type**: `string`
Defined in: [Developer/brk/modules/brk-client/index.js:725](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L725)
JSON Schema type (e.g., "integer", "number", "string", "boolean", "array", "object")