mirror of
https://github.com/bitcoinresearchkit/brk.git
synced 2026-04-26 15:49:58 -07:00
docs: update generated docs
This commit is contained in:
@@ -6,7 +6,7 @@
|
||||
|
||||
# Interface: PoolDetailInfo
|
||||
|
||||
Defined in: [Developer/brk/modules/brk-client/index.js:776](https://github.com/bitcoinresearchkit/brk/blob/c76b149ef9f4e0092fec3c6aef562bc4dddd8122/modules/brk-client/index.js#L776)
|
||||
Defined in: [Developer/brk/modules/brk-client/index.js:776](https://github.com/bitcoinresearchkit/brk/blob/1ddb3385e298de5498f1b3bf48bb88ed008d8e17/modules/brk-client/index.js#L776)
|
||||
|
||||
## Properties
|
||||
|
||||
@@ -14,7 +14,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:776](https://github.com/b
|
||||
|
||||
> **addresses**: `string`[]
|
||||
|
||||
Defined in: [Developer/brk/modules/brk-client/index.js:780](https://github.com/bitcoinresearchkit/brk/blob/c76b149ef9f4e0092fec3c6aef562bc4dddd8122/modules/brk-client/index.js#L780)
|
||||
Defined in: [Developer/brk/modules/brk-client/index.js:780](https://github.com/bitcoinresearchkit/brk/blob/1ddb3385e298de5498f1b3bf48bb88ed008d8e17/modules/brk-client/index.js#L780)
|
||||
|
||||
Known payout addresses
|
||||
|
||||
@@ -24,7 +24,7 @@ Known payout addresses
|
||||
|
||||
> **id**: `number`
|
||||
|
||||
Defined in: [Developer/brk/modules/brk-client/index.js:777](https://github.com/bitcoinresearchkit/brk/blob/c76b149ef9f4e0092fec3c6aef562bc4dddd8122/modules/brk-client/index.js#L777)
|
||||
Defined in: [Developer/brk/modules/brk-client/index.js:777](https://github.com/bitcoinresearchkit/brk/blob/1ddb3385e298de5498f1b3bf48bb88ed008d8e17/modules/brk-client/index.js#L777)
|
||||
|
||||
Pool identifier
|
||||
|
||||
@@ -34,7 +34,7 @@ Pool identifier
|
||||
|
||||
> **link**: `string`
|
||||
|
||||
Defined in: [Developer/brk/modules/brk-client/index.js:779](https://github.com/bitcoinresearchkit/brk/blob/c76b149ef9f4e0092fec3c6aef562bc4dddd8122/modules/brk-client/index.js#L779)
|
||||
Defined in: [Developer/brk/modules/brk-client/index.js:779](https://github.com/bitcoinresearchkit/brk/blob/1ddb3385e298de5498f1b3bf48bb88ed008d8e17/modules/brk-client/index.js#L779)
|
||||
|
||||
Pool website URL
|
||||
|
||||
@@ -44,7 +44,7 @@ Pool website URL
|
||||
|
||||
> **name**: `string`
|
||||
|
||||
Defined in: [Developer/brk/modules/brk-client/index.js:778](https://github.com/bitcoinresearchkit/brk/blob/c76b149ef9f4e0092fec3c6aef562bc4dddd8122/modules/brk-client/index.js#L778)
|
||||
Defined in: [Developer/brk/modules/brk-client/index.js:778](https://github.com/bitcoinresearchkit/brk/blob/1ddb3385e298de5498f1b3bf48bb88ed008d8e17/modules/brk-client/index.js#L778)
|
||||
|
||||
Pool name
|
||||
|
||||
@@ -54,7 +54,7 @@ Pool name
|
||||
|
||||
> **regexes**: `string`[]
|
||||
|
||||
Defined in: [Developer/brk/modules/brk-client/index.js:781](https://github.com/bitcoinresearchkit/brk/blob/c76b149ef9f4e0092fec3c6aef562bc4dddd8122/modules/brk-client/index.js#L781)
|
||||
Defined in: [Developer/brk/modules/brk-client/index.js:781](https://github.com/bitcoinresearchkit/brk/blob/1ddb3385e298de5498f1b3bf48bb88ed008d8e17/modules/brk-client/index.js#L781)
|
||||
|
||||
Coinbase tag patterns (regexes)
|
||||
|
||||
@@ -64,7 +64,7 @@ Coinbase tag patterns (regexes)
|
||||
|
||||
> **slug**: [`PoolSlug`](../type-aliases/PoolSlug.md)
|
||||
|
||||
Defined in: [Developer/brk/modules/brk-client/index.js:782](https://github.com/bitcoinresearchkit/brk/blob/c76b149ef9f4e0092fec3c6aef562bc4dddd8122/modules/brk-client/index.js#L782)
|
||||
Defined in: [Developer/brk/modules/brk-client/index.js:782](https://github.com/bitcoinresearchkit/brk/blob/1ddb3385e298de5498f1b3bf48bb88ed008d8e17/modules/brk-client/index.js#L782)
|
||||
|
||||
URL-friendly pool identifier
|
||||
|
||||
@@ -74,6 +74,6 @@ URL-friendly pool identifier
|
||||
|
||||
> **uniqueId**: `number`
|
||||
|
||||
Defined in: [Developer/brk/modules/brk-client/index.js:783](https://github.com/bitcoinresearchkit/brk/blob/c76b149ef9f4e0092fec3c6aef562bc4dddd8122/modules/brk-client/index.js#L783)
|
||||
Defined in: [Developer/brk/modules/brk-client/index.js:783](https://github.com/bitcoinresearchkit/brk/blob/1ddb3385e298de5498f1b3bf48bb88ed008d8e17/modules/brk-client/index.js#L783)
|
||||
|
||||
Unique pool identifier
|
||||
|
||||
Reference in New Issue
Block a user