apidocs

apidocs/interfaces/callresult.md

@@ -0,0 +1,70 @@
+[wasm-imagemagick](../README.md) > [CallResult](../interfaces/callresult.md)
+
+# Interface: CallResult
+
+The result of calling [call](../#call). Also the base class of results of calling [execute](executioncontext.md#execute).
+
+## Hierarchy
+
+**CallResult**
+
+↳  [ExecuteResultOne](executeresultone.md)
+
+## Index
+
+### Properties
+
+* [exitCode](callresult.md#exitcode)
+* [outputFiles](callresult.md#outputfiles)
+* [stderr](callresult.md#stderr)
+* [stdout](callresult.md#stdout)
+
+---
+
+## Properties
+
+<a id="exitcode"></a>
+
+###  exitCode
+
+**● exitCode**: *`number`*
+
+*Defined in [magickApi.ts:51](https://github.com/KnicKnic/WASM-ImageMagick/blob/7684a1c/src/magickApi.ts#L51)*
+
+Exit code of the command executed. If 0 the command executed successfully, otherwise an error occurred and `stderr` could have some information about what was wrong
+
+___
+<a id="outputfiles"></a>
+
+###  outputFiles
+
+**● outputFiles**: *[MagickOutputFile](magickoutputfile.md)[]*
+
+*Defined in [magickApi.ts:39](https://github.com/KnicKnic/WASM-ImageMagick/blob/7684a1c/src/magickApi.ts#L39)*
+
+Output files generated by the command, if any
+
+___
+<a id="stderr"></a>
+
+###  stderr
+
+**● stderr**: *`string`[]*
+
+*Defined in [magickApi.ts:47](https://github.com/KnicKnic/WASM-ImageMagick/blob/7684a1c/src/magickApi.ts#L47)*
+
+Output printed by the command to stderr. If `exitCode != 0` then this property could have some information about the error.
+
+___
+<a id="stdout"></a>
+
+###  stdout
+
+**● stdout**: *`string`[]*
+
+*Defined in [magickApi.ts:43](https://github.com/KnicKnic/WASM-ImageMagick/blob/7684a1c/src/magickApi.ts#L43)*
+
+Output printed by the command to stdout. For example the command `identify rose:` will print useful information to stdout
+
+___
+

apidocs/interfaces/executeconfig.md

@@ -0,0 +1,38 @@
+[wasm-imagemagick](../README.md) > [ExecuteConfig](../interfaces/executeconfig.md)
+
+# Interface: ExecuteConfig
+
+## Hierarchy
+
+**ExecuteConfig**
+
+## Index
+
+### Properties
+
+* [commands](executeconfig.md#commands)
+* [inputFiles](executeconfig.md#inputfiles)
+
+---
+
+## Properties
+
+<a id="commands"></a>
+
+###  commands
+
+**● commands**: *[ExecuteCommand](../#executecommand)*
+
+*Defined in [execute.ts:13](https://github.com/KnicKnic/WASM-ImageMagick/blob/7684a1c/src/execute.ts#L13)*
+
+___
+<a id="inputfiles"></a>
+
+### `<Optional>` inputFiles
+
+**● inputFiles**: *[MagickInputFile](magickinputfile.md)[]*
+
+*Defined in [execute.ts:10](https://github.com/KnicKnic/WASM-ImageMagick/blob/7684a1c/src/execute.ts#L10)*
+
+___
+

apidocs/interfaces/executeevent.md

@@ -0,0 +1,48 @@
+[wasm-imagemagick](../README.md) > [ExecuteEvent](../interfaces/executeevent.md)
+
+# Interface: ExecuteEvent
+
+## Hierarchy
+
+**ExecuteEvent**
+
+## Index
+
+### Properties
+
+* [command](executeevent.md#command)
+* [id](executeevent.md#id)
+* [took](executeevent.md#took)
+
+---
+
+## Properties
+
+<a id="command"></a>
+
+###  command
+
+**● command**: *[Command](../#command)*
+
+*Defined in [execute.ts:113](https://github.com/KnicKnic/WASM-ImageMagick/blob/7684a1c/src/execute.ts#L113)*
+
+___
+<a id="id"></a>
+
+###  id
+
+**● id**: *`number`*
+
+*Defined in [execute.ts:115](https://github.com/KnicKnic/WASM-ImageMagick/blob/7684a1c/src/execute.ts#L115)*
+
+___
+<a id="took"></a>
+
+###  took
+
+**● took**: *`number`*
+
+*Defined in [execute.ts:114](https://github.com/KnicKnic/WASM-ImageMagick/blob/7684a1c/src/execute.ts#L114)*
+
+___
+

apidocs/interfaces/executelistener.md

@@ -0,0 +1,54 @@
+[wasm-imagemagick](../README.md) > [ExecuteListener](../interfaces/executelistener.md)
+
+# Interface: ExecuteListener
+
+## Hierarchy
+
+**ExecuteListener**
+
+## Index
+
+### Methods
+
+* [afterExecute](executelistener.md#afterexecute)
+* [beforeExecute](executelistener.md#beforeexecute)
+
+---
+
+## Methods
+
+<a id="afterexecute"></a>
+
+### `<Optional>` afterExecute
+
+▸ **afterExecute**(event: *[ExecuteEvent](executeevent.md)*): `void`
+
+*Defined in [execute.ts:119](https://github.com/KnicKnic/WASM-ImageMagick/blob/7684a1c/src/execute.ts#L119)*
+
+**Parameters:**
+
+| Name | Type |
+| ------ | ------ |
+| event | [ExecuteEvent](executeevent.md) |
+
+**Returns:** `void`
+
+___
+<a id="beforeexecute"></a>
+
+### `<Optional>` beforeExecute
+
+▸ **beforeExecute**(event: *[ExecuteEvent](executeevent.md)*): `void`
+
+*Defined in [execute.ts:120](https://github.com/KnicKnic/WASM-ImageMagick/blob/7684a1c/src/execute.ts#L120)*
+
+**Parameters:**
+
+| Name | Type |
+| ------ | ------ |
+| event | [ExecuteEvent](executeevent.md) |
+
+**Returns:** `void`
+
+___
+

apidocs/interfaces/executeresult.md

@@ -0,0 +1,98 @@
+[wasm-imagemagick](../README.md) > [ExecuteResult](../interfaces/executeresult.md)
+
+# Interface: ExecuteResult
+
+## Hierarchy
+
+↳  [ExecuteResultOne](executeresultone.md)
+
+**↳ ExecuteResult**
+
+## Index
+
+### Properties
+
+* [errors](executeresult.md#errors)
+* [exitCode](executeresult.md#exitcode)
+* [outputFiles](executeresult.md#outputfiles)
+* [results](executeresult.md#results)
+* [stderr](executeresult.md#stderr)
+* [stdout](executeresult.md#stdout)
+
+---
+
+## Properties
+
+<a id="errors"></a>
+
+###  errors
+
+**● errors**: *`any`[]*
+
+*Inherited from [ExecuteResultOne](executeresultone.md).[errors](executeresultone.md#errors)*
+
+*Defined in [execute.ts:52](https://github.com/KnicKnic/WASM-ImageMagick/blob/7684a1c/src/execute.ts#L52)*
+
+___
+<a id="exitcode"></a>
+
+###  exitCode
+
+**● exitCode**: *`number`*
+
+*Inherited from [ExecuteResultOne](executeresultone.md).[exitCode](executeresultone.md#exitcode)*
+
+*Overrides [CallResult](callresult.md).[exitCode](callresult.md#exitcode)*
+
+*Defined in [execute.ts:53](https://github.com/KnicKnic/WASM-ImageMagick/blob/7684a1c/src/execute.ts#L53)*
+
+___
+<a id="outputfiles"></a>
+
+###  outputFiles
+
+**● outputFiles**: *[MagickOutputFile](magickoutputfile.md)[]*
+
+*Inherited from [CallResult](callresult.md).[outputFiles](callresult.md#outputfiles)*
+
+*Defined in [magickApi.ts:39](https://github.com/KnicKnic/WASM-ImageMagick/blob/7684a1c/src/magickApi.ts#L39)*
+
+Output files generated by the command, if any
+
+___
+<a id="results"></a>
+
+###  results
+
+**● results**: *[ExecuteResultOne](executeresultone.md)[]*
+
+*Defined in [execute.ts:130](https://github.com/KnicKnic/WASM-ImageMagick/blob/7684a1c/src/execute.ts#L130)*
+
+___
+<a id="stderr"></a>
+
+###  stderr
+
+**● stderr**: *`string`[]*
+
+*Inherited from [CallResult](callresult.md).[stderr](callresult.md#stderr)*
+
+*Defined in [magickApi.ts:47](https://github.com/KnicKnic/WASM-ImageMagick/blob/7684a1c/src/magickApi.ts#L47)*
+
+Output printed by the command to stderr. If `exitCode != 0` then this property could have some information about the error.
+
+___
+<a id="stdout"></a>
+
+###  stdout
+
+**● stdout**: *`string`[]*
+
+*Inherited from [CallResult](callresult.md).[stdout](callresult.md#stdout)*
+
+*Defined in [magickApi.ts:43](https://github.com/KnicKnic/WASM-ImageMagick/blob/7684a1c/src/magickApi.ts#L43)*
+
+Output printed by the command to stdout. For example the command `identify rose:` will print useful information to stdout
+
+___
+

apidocs/interfaces/executeresultone.md

@@ -0,0 +1,86 @@
+[wasm-imagemagick](../README.md) > [ExecuteResultOne](../interfaces/executeresultone.md)
+
+# Interface: ExecuteResultOne
+
+## Hierarchy
+
+ [CallResult](callresult.md)
+
+**↳ ExecuteResultOne**
+
+↳  [ExecuteResult](executeresult.md)
+
+## Index
+
+### Properties
+
+* [errors](executeresultone.md#errors)
+* [exitCode](executeresultone.md#exitcode)
+* [outputFiles](executeresultone.md#outputfiles)
+* [stderr](executeresultone.md#stderr)
+* [stdout](executeresultone.md#stdout)
+
+---
+
+## Properties
+
+<a id="errors"></a>
+
+###  errors
+
+**● errors**: *`any`[]*
+
+*Defined in [execute.ts:52](https://github.com/KnicKnic/WASM-ImageMagick/blob/7684a1c/src/execute.ts#L52)*
+
+___
+<a id="exitcode"></a>
+
+###  exitCode
+
+**● exitCode**: *`number`*
+
+*Overrides [CallResult](callresult.md).[exitCode](callresult.md#exitcode)*
+
+*Defined in [execute.ts:53](https://github.com/KnicKnic/WASM-ImageMagick/blob/7684a1c/src/execute.ts#L53)*
+
+___
+<a id="outputfiles"></a>
+
+###  outputFiles
+
+**● outputFiles**: *[MagickOutputFile](magickoutputfile.md)[]*
+
+*Inherited from [CallResult](callresult.md).[outputFiles](callresult.md#outputfiles)*
+
+*Defined in [magickApi.ts:39](https://github.com/KnicKnic/WASM-ImageMagick/blob/7684a1c/src/magickApi.ts#L39)*
+
+Output files generated by the command, if any
+
+___
+<a id="stderr"></a>
+
+###  stderr
+
+**● stderr**: *`string`[]*
+
+*Inherited from [CallResult](callresult.md).[stderr](callresult.md#stderr)*
+
+*Defined in [magickApi.ts:47](https://github.com/KnicKnic/WASM-ImageMagick/blob/7684a1c/src/magickApi.ts#L47)*
+
+Output printed by the command to stderr. If `exitCode != 0` then this property could have some information about the error.
+
+___
+<a id="stdout"></a>
+
+###  stdout
+
+**● stdout**: *`string`[]*
+
+*Inherited from [CallResult](callresult.md).[stdout](callresult.md#stdout)*
+
+*Defined in [magickApi.ts:43](https://github.com/KnicKnic/WASM-ImageMagick/blob/7684a1c/src/magickApi.ts#L43)*
+
+Output printed by the command to stdout. For example the command `identify rose:` will print useful information to stdout
+
+___
+