Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Direct IO #133

Merged
merged 23 commits into from
Apr 7, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
578 changes: 255 additions & 323 deletions doc/README.md

Large diffs are not rendered by default.

168 changes: 131 additions & 37 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,26 +49,33 @@

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

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

## Methods

### addListener

▸ **addListener**(`event`: string | symbol, `listener`: Function): *this*
▸ **addListener**(`event`: string | symbol, `listener`: function): *this*

*Inherited from [SourceSource](sourcesource.md).[addListener](sourcesource.md#addlistener)*

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

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

**Parameters:**

▪ **event**: *string | symbol*

▪ **listener**: *function*

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

**Parameters:**

Name | Type |
------ | ------ |
`event` | string | symbol |
`listener` | Function |
`...args` | any[] |

**Returns:** *this*

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

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

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

**Parameters:**

Expand All @@ -95,15 +104,15 @@ ___

### eventNames

▸ **eventNames**(): *string | symbol[]*
▸ **eventNames**(): *Array‹string | symbol*

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

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

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

**Returns:** *string | symbol[]*
**Returns:** *Array‹string | symbol*

___

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

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

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

**Returns:** *number*

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

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

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

**Parameters:**

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

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

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

**Parameters:**

Expand All @@ -161,90 +170,166 @@ 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*
▸ **on**(`event`: string | symbol, `listener`: function): *this*

*Inherited from [SourceSource](sourcesource.md).[on](sourcesource.md#on)*

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

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

**Parameters:**

▪ **event**: *string | symbol*

▪ **listener**: *function*

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

**Parameters:**

Name | Type |
------ | ------ |
`event` | string | symbol |
`listener` | Function |
`...args` | any[] |

**Returns:** *this*

___

### once

▸ **once**(`event`: string | symbol, `listener`: Function): *this*
▸ **once**(`event`: string | symbol, `listener`: function): *this*

*Inherited from [SourceSource](sourcesource.md).[once](sourcesource.md#once)*

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

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

**Parameters:**

▪ **event**: *string | symbol*

▪ **listener**: *function*

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

**Parameters:**

Name | Type |
------ | ------ |
`event` | string | symbol |
`listener` | Function |
`...args` | any[] |

**Returns:** *this*

___

### prependListener

▸ **prependListener**(`event`: string | symbol, `listener`: Function): *this*
▸ **prependListener**(`event`: string | symbol, `listener`: function): *this*

*Inherited from [SourceSource](sourcesource.md).[prependListener](sourcesource.md#prependlistener)*

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

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

**Parameters:**

▪ **event**: *string | symbol*

▪ **listener**: *function*

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

**Parameters:**

Name | Type |
------ | ------ |
`event` | string | symbol |
`listener` | Function |
`...args` | any[] |

**Returns:** *this*

___

### prependOnceListener

▸ **prependOnceListener**(`event`: string | symbol, `listener`: Function): *this*
▸ **prependOnceListener**(`event`: string | symbol, `listener`: function): *this*

*Inherited from [SourceSource](sourcesource.md).[prependOnceListener](sourcesource.md#prependoncelistener)*

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

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

**Parameters:**

▪ **event**: *string | symbol*

▪ **listener**: *function*

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

**Parameters:**

Name | Type |
------ | ------ |
`event` | string | symbol |
`listener` | Function |
`...args` | any[] |

**Returns:** *this*

___

### 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 @@ -253,7 +338,7 @@ ___

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

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

**Parameters:**

Expand All @@ -267,20 +352,27 @@ ___

### removeListener

▸ **removeListener**(`event`: string | symbol, `listener`: Function): *this*
▸ **removeListener**(`event`: string | symbol, `listener`: function): *this*

*Inherited from [SourceSource](sourcesource.md).[removeListener](sourcesource.md#removelistener)*

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

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

**Parameters:**

▪ **event**: *string | symbol*

▪ **listener**: *function*

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

**Parameters:**

Name | Type |
------ | ------ |
`event` | string | symbol |
`listener` | Function |
`...args` | any[] |

**Returns:** *this*

Expand All @@ -294,7 +386,7 @@ ___

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

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

**Parameters:**

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

▸ **start**(): *void*

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

**Returns:** *void*

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

▸ **stop**(): *void*

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

**Returns:** *void*

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

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

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

**`deprecated`** since v4.0.0

**Parameters:**

Expand Down
Loading