Skip to content

Commit

Permalink
Update generated docs
Browse files Browse the repository at this point in the history
Change-type: patch
  • Loading branch information
zvin committed Apr 7, 2020
1 parent 52dfc17 commit b7d24d2
Show file tree
Hide file tree
Showing 69 changed files with 6,712 additions and 4,115 deletions.
343 changes: 138 additions & 205 deletions doc/README.md

Large diffs are not rendered by default.

86 changes: 69 additions & 17 deletions doc/classes/adapter.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,12 @@
* [getMaxListeners](adapter.md#getmaxlisteners)
* [listenerCount](adapter.md#listenercount)
* [listeners](adapter.md#listeners)
* [off](adapter.md#off)
* [on](adapter.md#on)
* [once](adapter.md#once)
* [prependListener](adapter.md#prependlistener)
* [prependOnceListener](adapter.md#prependoncelistener)
* [rawListeners](adapter.md#rawlisteners)
* [removeAllListeners](adapter.md#removealllisteners)
* [removeListener](adapter.md#removelistener)
* [setMaxListeners](adapter.md#setmaxlisteners)
Expand All @@ -47,7 +49,7 @@

*Inherited from [CountingWritable](countingwritable.md).[defaultMaxListeners](countingwritable.md#static-defaultmaxlisteners)*

Defined in node_modules/@types/node/base.d.ts:896
Defined in node_modules/@types/node/events.d.ts:18

## Methods

Expand All @@ -59,7 +61,7 @@ Defined in node_modules/@types/node/base.d.ts:896

*Overrides [SparseReadable](../interfaces/sparsereadable.md).[addListener](../interfaces/sparsereadable.md#addlistener)*

Defined in node_modules/@types/node/base.d.ts:898
Defined in node_modules/@types/node/events.d.ts:20

**Parameters:**

Expand Down Expand Up @@ -87,7 +89,7 @@ ___

*Overrides [SparseReadable](../interfaces/sparsereadable.md).[emit](../interfaces/sparsereadable.md#emit)*

Defined in node_modules/@types/node/base.d.ts:908
Defined in node_modules/@types/node/events.d.ts:32

**Parameters:**

Expand All @@ -108,7 +110,7 @@ ___

*Overrides [SparseReadable](../interfaces/sparsereadable.md).[eventNames](../interfaces/sparsereadable.md#eventnames)*

Defined in node_modules/@types/node/base.d.ts:909
Defined in node_modules/@types/node/events.d.ts:33

**Returns:** *Array‹string | symbol›*

Expand All @@ -122,7 +124,7 @@ ___

*Overrides [SparseReadable](../interfaces/sparsereadable.md).[getMaxListeners](../interfaces/sparsereadable.md#getmaxlisteners)*

Defined in node_modules/@types/node/base.d.ts:906
Defined in node_modules/@types/node/events.d.ts:29

**Returns:** *number*

Expand All @@ -136,7 +138,7 @@ ___

*Overrides [SparseReadable](../interfaces/sparsereadable.md).[listenerCount](../interfaces/sparsereadable.md#listenercount)*

Defined in node_modules/@types/node/base.d.ts:910
Defined in node_modules/@types/node/events.d.ts:34

**Parameters:**

Expand All @@ -156,7 +158,7 @@ ___

*Overrides [SparseReadable](../interfaces/sparsereadable.md).[listeners](../interfaces/sparsereadable.md#listeners)*

Defined in node_modules/@types/node/base.d.ts:907
Defined in node_modules/@types/node/events.d.ts:30

**Parameters:**

Expand All @@ -168,6 +170,34 @@ Name | Type |

___

### off

**off**(`event`: string | symbol, `listener`: function): *this*

*Inherited from [CountingWritable](countingwritable.md).[off](countingwritable.md#off)*

*Overrides [SparseReadable](../interfaces/sparsereadable.md).[off](../interfaces/sparsereadable.md#off)*

Defined in node_modules/@types/node/events.d.ts:26

**Parameters:**

**event**: *string | symbol*

**listener**: *function*

▸ (...`args`: any[]): *void*

**Parameters:**

Name | Type |
------ | ------ |
`...args` | any[] |

**Returns:** *this*

___

### on

**on**(`event`: string | symbol, `listener`: function): *this*
Expand All @@ -176,7 +206,7 @@ ___

*Overrides [SparseReadable](../interfaces/sparsereadable.md).[on](../interfaces/sparsereadable.md#on)*

Defined in node_modules/@types/node/base.d.ts:899
Defined in node_modules/@types/node/events.d.ts:21

**Parameters:**

Expand Down Expand Up @@ -204,7 +234,7 @@ ___

*Overrides [SparseReadable](../interfaces/sparsereadable.md).[once](../interfaces/sparsereadable.md#once)*

Defined in node_modules/@types/node/base.d.ts:900
Defined in node_modules/@types/node/events.d.ts:22

**Parameters:**

Expand Down Expand Up @@ -232,7 +262,7 @@ ___

*Overrides [SparseReadable](../interfaces/sparsereadable.md).[prependListener](../interfaces/sparsereadable.md#prependlistener)*

Defined in node_modules/@types/node/base.d.ts:901
Defined in node_modules/@types/node/events.d.ts:23

**Parameters:**

Expand Down Expand Up @@ -260,7 +290,7 @@ ___

*Overrides [SparseReadable](../interfaces/sparsereadable.md).[prependOnceListener](../interfaces/sparsereadable.md#prependoncelistener)*

Defined in node_modules/@types/node/base.d.ts:902
Defined in node_modules/@types/node/events.d.ts:24

**Parameters:**

Expand All @@ -280,6 +310,26 @@ Name | Type |

___

### rawListeners

**rawListeners**(`event`: string | symbol): *Function[]*

*Inherited from [CountingWritable](countingwritable.md).[rawListeners](countingwritable.md#rawlisteners)*

*Overrides [SparseReadable](../interfaces/sparsereadable.md).[rawListeners](../interfaces/sparsereadable.md#rawlisteners)*

Defined in node_modules/@types/node/events.d.ts:31

**Parameters:**

Name | Type |
------ | ------ |
`event` | string | symbol |

**Returns:** *Function[]*

___

### removeAllListeners

**removeAllListeners**(`event?`: string | symbol): *this*
Expand All @@ -288,7 +338,7 @@ ___

*Overrides [SparseReadable](../interfaces/sparsereadable.md).[removeAllListeners](../interfaces/sparsereadable.md#removealllisteners)*

Defined in node_modules/@types/node/base.d.ts:904
Defined in node_modules/@types/node/events.d.ts:27

**Parameters:**

Expand All @@ -308,7 +358,7 @@ ___

*Overrides [SparseReadable](../interfaces/sparsereadable.md).[removeListener](../interfaces/sparsereadable.md#removelistener)*

Defined in node_modules/@types/node/base.d.ts:903
Defined in node_modules/@types/node/events.d.ts:25

**Parameters:**

Expand Down Expand Up @@ -336,7 +386,7 @@ ___

*Overrides [SparseReadable](../interfaces/sparsereadable.md).[setMaxListeners](../interfaces/sparsereadable.md#setmaxlisteners)*

Defined in node_modules/@types/node/base.d.ts:905
Defined in node_modules/@types/node/events.d.ts:28

**Parameters:**

Expand All @@ -352,7 +402,7 @@ ___

**start**(): *void*

*Defined in [lib/scanner/adapters/adapter.ts:34](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/scanner/adapters/adapter.ts#L34)*
*Defined in [lib/scanner/adapters/adapter.ts:34](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/scanner/adapters/adapter.ts#L34)*

**Returns:** *void*

Expand All @@ -362,7 +412,7 @@ ___

**stop**(): *void*

*Defined in [lib/scanner/adapters/adapter.ts:35](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/scanner/adapters/adapter.ts#L35)*
*Defined in [lib/scanner/adapters/adapter.ts:35](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/scanner/adapters/adapter.ts#L35)*

**Returns:** *void*

Expand All @@ -374,7 +424,9 @@ ___

*Inherited from [CountingWritable](countingwritable.md).[listenerCount](countingwritable.md#static-listenercount)*

Defined in node_modules/@types/node/base.d.ts:895
Defined in node_modules/@types/node/events.d.ts:17

**`deprecated`** since v4.0.0

**Parameters:**

Expand Down
14 changes: 7 additions & 7 deletions doc/classes/alignedreadablestate.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@

\+ **new AlignedReadableState**(`bufferSize`: number, `alignment`: number, `numBuffers`: number): *[AlignedReadableState](alignedreadablestate.md)*

*Defined in [lib/aligned-lockable-buffer.ts:47](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/aligned-lockable-buffer.ts#L47)*
*Defined in [lib/aligned-lockable-buffer.ts:55](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/aligned-lockable-buffer.ts#L55)*

**Parameters:**

Expand All @@ -48,46 +48,46 @@ Name | Type |

**alignment**: *number*

*Defined in [lib/aligned-lockable-buffer.ts:51](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/aligned-lockable-buffer.ts#L51)*
*Defined in [lib/aligned-lockable-buffer.ts:59](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/aligned-lockable-buffer.ts#L59)*

___

### `Private` bufferSize

**bufferSize**: *number*

*Defined in [lib/aligned-lockable-buffer.ts:50](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/aligned-lockable-buffer.ts#L50)*
*Defined in [lib/aligned-lockable-buffer.ts:58](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/aligned-lockable-buffer.ts#L58)*

___

### `Private` buffers

**buffers**: *[AlignedLockableBuffer](../interfaces/alignedlockablebuffer.md)[]*

*Defined in [lib/aligned-lockable-buffer.ts:46](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/aligned-lockable-buffer.ts#L46)*
*Defined in [lib/aligned-lockable-buffer.ts:54](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/aligned-lockable-buffer.ts#L54)*

___

### `Private` currentBufferIndex

**currentBufferIndex**: *number* = 0

*Defined in [lib/aligned-lockable-buffer.ts:47](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/aligned-lockable-buffer.ts#L47)*
*Defined in [lib/aligned-lockable-buffer.ts:55](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/aligned-lockable-buffer.ts#L55)*

___

### `Private` numBuffers

**numBuffers**: *number*

*Defined in [lib/aligned-lockable-buffer.ts:52](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/aligned-lockable-buffer.ts#L52)*
*Defined in [lib/aligned-lockable-buffer.ts:60](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/aligned-lockable-buffer.ts#L60)*

## Methods

### getCurrentBuffer

**getCurrentBuffer**(): *[AlignedLockableBuffer](../interfaces/alignedlockablebuffer.md)*

*Defined in [lib/aligned-lockable-buffer.ts:57](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/aligned-lockable-buffer.ts#L57)*
*Defined in [lib/aligned-lockable-buffer.ts:65](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/aligned-lockable-buffer.ts#L65)*

**Returns:** *[AlignedLockableBuffer](../interfaces/alignedlockablebuffer.md)*
Loading

0 comments on commit b7d24d2

Please sign in to comment.