Skip to content

Commit

Permalink
Documentation update
Browse files Browse the repository at this point in the history
  • Loading branch information
robdmoore committed Nov 25, 2023
1 parent c80d1b0 commit 946e62c
Show file tree
Hide file tree
Showing 12 changed files with 74 additions and 74 deletions.
22 changes: 11 additions & 11 deletions docs/code/classes/index.AlgorandSubscriber.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ Create a new `AlgorandSubscriber`.

#### Defined in

[subscriber.ts:23](https://github.com/MakerXStudio/algorand-indexer-poc/blob/main/src/subscriber.ts#L23)
[subscriber.ts:23](https://github.com/algorandfoundation/algokit-subscriber-ts/blob/main/src/subscriber.ts#L23)

## Properties

Expand All @@ -60,7 +60,7 @@ Create a new `AlgorandSubscriber`.

#### Defined in

[subscriber.ts:14](https://github.com/MakerXStudio/algorand-indexer-poc/blob/main/src/subscriber.ts#L14)
[subscriber.ts:14](https://github.com/algorandfoundation/algokit-subscriber-ts/blob/main/src/subscriber.ts#L14)

___

Expand All @@ -70,7 +70,7 @@ ___

#### Defined in

[subscriber.ts:11](https://github.com/MakerXStudio/algorand-indexer-poc/blob/main/src/subscriber.ts#L11)
[subscriber.ts:11](https://github.com/algorandfoundation/algokit-subscriber-ts/blob/main/src/subscriber.ts#L11)

___

Expand All @@ -80,7 +80,7 @@ ___

#### Defined in

[subscriber.ts:15](https://github.com/MakerXStudio/algorand-indexer-poc/blob/main/src/subscriber.ts#L15)
[subscriber.ts:15](https://github.com/algorandfoundation/algokit-subscriber-ts/blob/main/src/subscriber.ts#L15)

___

Expand All @@ -90,7 +90,7 @@ ___

#### Defined in

[subscriber.ts:12](https://github.com/MakerXStudio/algorand-indexer-poc/blob/main/src/subscriber.ts#L12)
[subscriber.ts:12](https://github.com/algorandfoundation/algokit-subscriber-ts/blob/main/src/subscriber.ts#L12)

___

Expand All @@ -100,7 +100,7 @@ ___

#### Defined in

[subscriber.ts:13](https://github.com/MakerXStudio/algorand-indexer-poc/blob/main/src/subscriber.ts#L13)
[subscriber.ts:13](https://github.com/algorandfoundation/algokit-subscriber-ts/blob/main/src/subscriber.ts#L13)

## Methods

Expand Down Expand Up @@ -131,7 +131,7 @@ The listener can be async and it will be awaited if so.

#### Defined in

[subscriber.ts:106](https://github.com/MakerXStudio/algorand-indexer-poc/blob/main/src/subscriber.ts#L106)
[subscriber.ts:106](https://github.com/algorandfoundation/algokit-subscriber-ts/blob/main/src/subscriber.ts#L106)

___

Expand Down Expand Up @@ -166,7 +166,7 @@ The listener can be async and it will be awaited if so.

#### Defined in

[subscriber.ts:121](https://github.com/MakerXStudio/algorand-indexer-poc/blob/main/src/subscriber.ts#L121)
[subscriber.ts:121](https://github.com/algorandfoundation/algokit-subscriber-ts/blob/main/src/subscriber.ts#L121)

___

Expand All @@ -185,7 +185,7 @@ triggered by a recurring schedule / cron.

#### Defined in

[subscriber.ts:46](https://github.com/MakerXStudio/algorand-indexer-poc/blob/main/src/subscriber.ts#L46)
[subscriber.ts:46](https://github.com/algorandfoundation/algokit-subscriber-ts/blob/main/src/subscriber.ts#L46)

___

Expand All @@ -203,7 +203,7 @@ This is useful when running in the context of a long-running process / container

#### Defined in

[subscriber.ts:81](https://github.com/MakerXStudio/algorand-indexer-poc/blob/main/src/subscriber.ts#L81)
[subscriber.ts:81](https://github.com/algorandfoundation/algokit-subscriber-ts/blob/main/src/subscriber.ts#L81)

___

Expand All @@ -225,4 +225,4 @@ Stops the subscriber if previously started via `start`.

#### Defined in

[subscriber.ts:95](https://github.com/MakerXStudio/algorand-indexer-poc/blob/main/src/subscriber.ts#L95)
[subscriber.ts:95](https://github.com/algorandfoundation/algokit-subscriber-ts/blob/main/src/subscriber.ts#L95)
14 changes: 7 additions & 7 deletions docs/code/classes/types_async_event_emitter.AsyncEventEmitter.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ Simple asynchronous event emitter class.

#### Defined in

types/async-event-emitter.ts:12
[types/async-event-emitter.ts:12](https://github.com/algorandfoundation/algokit-subscriber-ts/blob/main/src/types/async-event-emitter.ts#L12)

___

Expand All @@ -55,7 +55,7 @@ ___

#### Defined in

types/async-event-emitter.ts:11
[types/async-event-emitter.ts:11](https://github.com/algorandfoundation/algokit-subscriber-ts/blob/main/src/types/async-event-emitter.ts#L11)

___

Expand All @@ -82,7 +82,7 @@ Alias for `removeListener`.

#### Defined in

types/async-event-emitter.ts:82
[types/async-event-emitter.ts:82](https://github.com/algorandfoundation/algokit-subscriber-ts/blob/main/src/types/async-event-emitter.ts#L82)

## Methods

Expand All @@ -106,7 +106,7 @@ in the order they were registered.

#### Defined in

types/async-event-emitter.ts:21
[types/async-event-emitter.ts:21](https://github.com/algorandfoundation/algokit-subscriber-ts/blob/main/src/types/async-event-emitter.ts#L21)

___

Expand All @@ -131,7 +131,7 @@ The `AsyncEventEmitter` so you can chain registrations

#### Defined in

types/async-event-emitter.ts:33
[types/async-event-emitter.ts:33](https://github.com/algorandfoundation/algokit-subscriber-ts/blob/main/src/types/async-event-emitter.ts#L33)

___

Expand All @@ -156,7 +156,7 @@ The `AsyncEventEmitter` so you can chain registrations

#### Defined in

types/async-event-emitter.ts:45
[types/async-event-emitter.ts:45](https://github.com/algorandfoundation/algokit-subscriber-ts/blob/main/src/types/async-event-emitter.ts#L45)

___

Expand All @@ -181,4 +181,4 @@ The `AsyncEventEmitter` so you can chain registrations

#### Defined in

types/async-event-emitter.ts:63
[types/async-event-emitter.ts:63](https://github.com/algorandfoundation/algokit-subscriber-ts/blob/main/src/types/async-event-emitter.ts#L63)
34 changes: 17 additions & 17 deletions docs/code/interfaces/types_block.Block.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ since genesis.

#### Defined in

[types/block.ts:12](https://github.com/MakerXStudio/algorand-indexer-poc/blob/main/src/types/block.ts#L12)
[types/block.ts:12](https://github.com/algorandfoundation/algokit-subscriber-ts/blob/main/src/types/block.ts#L12)

___

Expand All @@ -56,7 +56,7 @@ The FeeSink accepts transaction fees. It can only spend to the incentive pool.

#### Defined in

[types/block.ts:14](https://github.com/MakerXStudio/algorand-indexer-poc/blob/main/src/types/block.ts#L14)
[types/block.ts:14](https://github.com/algorandfoundation/algokit-subscriber-ts/blob/main/src/types/block.ts#L14)

___

Expand All @@ -69,7 +69,7 @@ MicroAlgos for every reward unit in the next round.

#### Defined in

[types/block.ts:18](https://github.com/MakerXStudio/algorand-indexer-poc/blob/main/src/types/block.ts#L18)
[types/block.ts:18](https://github.com/algorandfoundation/algokit-subscriber-ts/blob/main/src/types/block.ts#L18)

___

Expand All @@ -81,7 +81,7 @@ Genesis ID to which this block belongs.

#### Defined in

[types/block.ts:20](https://github.com/MakerXStudio/algorand-indexer-poc/blob/main/src/types/block.ts#L20)
[types/block.ts:20](https://github.com/algorandfoundation/algokit-subscriber-ts/blob/main/src/types/block.ts#L20)

___

Expand All @@ -93,7 +93,7 @@ Genesis hash to which this block belongs.

#### Defined in

[types/block.ts:22](https://github.com/MakerXStudio/algorand-indexer-poc/blob/main/src/types/block.ts#L22)
[types/block.ts:22](https://github.com/algorandfoundation/algokit-subscriber-ts/blob/main/src/types/block.ts#L22)

___

Expand All @@ -105,7 +105,7 @@ The hash of the previous block

#### Defined in

[types/block.ts:24](https://github.com/MakerXStudio/algorand-indexer-poc/blob/main/src/types/block.ts#L24)
[types/block.ts:24](https://github.com/algorandfoundation/algokit-subscriber-ts/blob/main/src/types/block.ts#L24)

___

Expand All @@ -117,7 +117,7 @@ UpgradeState tracks the protocol upgrade state machine; proto is the current pro

#### Defined in

[types/block.ts:26](https://github.com/MakerXStudio/algorand-indexer-poc/blob/main/src/types/block.ts#L26)
[types/block.ts:26](https://github.com/algorandfoundation/algokit-subscriber-ts/blob/main/src/types/block.ts#L26)

___

Expand All @@ -129,7 +129,7 @@ The number of new MicroAlgos added to the participation stake from rewards at th

#### Defined in

[types/block.ts:28](https://github.com/MakerXStudio/algorand-indexer-poc/blob/main/src/types/block.ts#L28)
[types/block.ts:28](https://github.com/algorandfoundation/algokit-subscriber-ts/blob/main/src/types/block.ts#L28)

___

Expand All @@ -141,7 +141,7 @@ Round number.

#### Defined in

[types/block.ts:30](https://github.com/MakerXStudio/algorand-indexer-poc/blob/main/src/types/block.ts#L30)
[types/block.ts:30](https://github.com/algorandfoundation/algokit-subscriber-ts/blob/main/src/types/block.ts#L30)

___

Expand All @@ -153,7 +153,7 @@ The round at which the RewardsRate will be recalculated.

#### Defined in

[types/block.ts:32](https://github.com/MakerXStudio/algorand-indexer-poc/blob/main/src/types/block.ts#L32)
[types/block.ts:32](https://github.com/algorandfoundation/algokit-subscriber-ts/blob/main/src/types/block.ts#L32)

___

Expand All @@ -166,7 +166,7 @@ FeeSink and continually redistributes them to addresses as rewards.

#### Defined in

[types/block.ts:36](https://github.com/MakerXStudio/algorand-indexer-poc/blob/main/src/types/block.ts#L36)
[types/block.ts:36](https://github.com/algorandfoundation/algokit-subscriber-ts/blob/main/src/types/block.ts#L36)

___

Expand All @@ -178,7 +178,7 @@ Sortition seed

#### Defined in

[types/block.ts:38](https://github.com/MakerXStudio/algorand-indexer-poc/blob/main/src/types/block.ts#L38)
[types/block.ts:38](https://github.com/algorandfoundation/algokit-subscriber-ts/blob/main/src/types/block.ts#L38)

___

Expand All @@ -192,7 +192,7 @@ committed after this block. Genesis blocks can start at either

#### Defined in

[types/block.ts:43](https://github.com/MakerXStudio/algorand-indexer-poc/blob/main/src/types/block.ts#L43)
[types/block.ts:43](https://github.com/algorandfoundation/algokit-subscriber-ts/blob/main/src/types/block.ts#L43)

___

Expand All @@ -204,7 +204,7 @@ Round time (unix timestamp)

#### Defined in

[types/block.ts:45](https://github.com/MakerXStudio/algorand-indexer-poc/blob/main/src/types/block.ts#L45)
[types/block.ts:45](https://github.com/algorandfoundation/algokit-subscriber-ts/blob/main/src/types/block.ts#L45)

___

Expand All @@ -217,7 +217,7 @@ This commitment is computed based on the PaysetCommit type specified in the bloc

#### Defined in

[types/block.ts:49](https://github.com/MakerXStudio/algorand-indexer-poc/blob/main/src/types/block.ts#L49)
[types/block.ts:49](https://github.com/algorandfoundation/algokit-subscriber-ts/blob/main/src/types/block.ts#L49)

___

Expand All @@ -229,7 +229,7 @@ Root of transaction vector commitment merkle tree using SHA256 hash function.

#### Defined in

[types/block.ts:53](https://github.com/MakerXStudio/algorand-indexer-poc/blob/main/src/types/block.ts#L53)
[types/block.ts:53](https://github.com/algorandfoundation/algokit-subscriber-ts/blob/main/src/types/block.ts#L53)

___

Expand All @@ -241,4 +241,4 @@ The transactions within the block.

#### Defined in

[types/block.ts:55](https://github.com/MakerXStudio/algorand-indexer-poc/blob/main/src/types/block.ts#L55)
[types/block.ts:55](https://github.com/algorandfoundation/algokit-subscriber-ts/blob/main/src/types/block.ts#L55)
12 changes: 6 additions & 6 deletions docs/code/interfaces/types_block.BlockTransaction.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Asset closing amount in decimal units

#### Defined in

[types/block.ts:66](https://github.com/MakerXStudio/algorand-indexer-poc/blob/main/src/types/block.ts#L66)
[types/block.ts:66](https://github.com/algorandfoundation/algokit-subscriber-ts/blob/main/src/types/block.ts#L66)

___

Expand All @@ -37,7 +37,7 @@ App ID when an app is created by the transaction

#### Defined in

[types/block.ts:64](https://github.com/MakerXStudio/algorand-indexer-poc/blob/main/src/types/block.ts#L64)
[types/block.ts:64](https://github.com/algorandfoundation/algokit-subscriber-ts/blob/main/src/types/block.ts#L64)

___

Expand All @@ -49,7 +49,7 @@ Algo closing amount in microAlgos

#### Defined in

[types/block.ts:68](https://github.com/MakerXStudio/algorand-indexer-poc/blob/main/src/types/block.ts#L68)
[types/block.ts:68](https://github.com/algorandfoundation/algokit-subscriber-ts/blob/main/src/types/block.ts#L68)

___

Expand All @@ -61,7 +61,7 @@ Asset ID when an asset is created by the transaction

#### Defined in

[types/block.ts:62](https://github.com/MakerXStudio/algorand-indexer-poc/blob/main/src/types/block.ts#L62)
[types/block.ts:62](https://github.com/algorandfoundation/algokit-subscriber-ts/blob/main/src/types/block.ts#L62)

___

Expand All @@ -73,7 +73,7 @@ Has genesis id

#### Defined in

[types/block.ts:70](https://github.com/MakerXStudio/algorand-indexer-poc/blob/main/src/types/block.ts#L70)
[types/block.ts:70](https://github.com/algorandfoundation/algokit-subscriber-ts/blob/main/src/types/block.ts#L70)

___

Expand All @@ -85,4 +85,4 @@ The encoded transaction data

#### Defined in

[types/block.ts:60](https://github.com/MakerXStudio/algorand-indexer-poc/blob/main/src/types/block.ts#L60)
[types/block.ts:60](https://github.com/algorandfoundation/algokit-subscriber-ts/blob/main/src/types/block.ts#L60)
10 changes: 5 additions & 5 deletions docs/code/interfaces/types_subscription.SubscriptionConfig.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ The set of events to subscribe to / emit

#### Defined in

[types/subscription.ts:106](https://github.com/MakerXStudio/algorand-indexer-poc/blob/main/src/types/subscription.ts#L106)
[types/subscription.ts:106](https://github.com/algorandfoundation/algokit-subscriber-ts/blob/main/src/types/subscription.ts#L106)

___

Expand All @@ -38,7 +38,7 @@ The frequency to poll for new blocks in seconds

#### Defined in

[types/subscription.ts:102](https://github.com/MakerXStudio/algorand-indexer-poc/blob/main/src/types/subscription.ts#L102)
[types/subscription.ts:102](https://github.com/algorandfoundation/algokit-subscriber-ts/blob/main/src/types/subscription.ts#L102)

___

Expand All @@ -50,7 +50,7 @@ The maximum number of rounds to sync at a time.

#### Defined in

[types/subscription.ts:104](https://github.com/MakerXStudio/algorand-indexer-poc/blob/main/src/types/subscription.ts#L104)
[types/subscription.ts:104](https://github.com/algorandfoundation/algokit-subscriber-ts/blob/main/src/types/subscription.ts#L104)

___

Expand All @@ -70,7 +70,7 @@ The behaviour when the number of rounds to sync is greater than `maxRoundsToSync

#### Defined in

[types/subscription.ts:117](https://github.com/MakerXStudio/algorand-indexer-poc/blob/main/src/types/subscription.ts#L117)
[types/subscription.ts:117](https://github.com/algorandfoundation/algokit-subscriber-ts/blob/main/src/types/subscription.ts#L117)

___

Expand All @@ -90,4 +90,4 @@ its position in the chain.

#### Defined in

[types/subscription.ts:120](https://github.com/MakerXStudio/algorand-indexer-poc/blob/main/src/types/subscription.ts#L120)
[types/subscription.ts:120](https://github.com/algorandfoundation/algokit-subscriber-ts/blob/main/src/types/subscription.ts#L120)
Loading

0 comments on commit 946e62c

Please sign in to comment.