docs: update api reference

NorbertKlockiewicz · NorbertKlockiewicz · commit c21480b91d5a · 2026-02-26T14:56:57.000+01:00
diff --git a/docs/docs/06-api-reference/classes/ClassificationModule.md b/docs/docs/06-api-reference/classes/ClassificationModule.md
@@ -223,7 +223,7 @@ The input shape as an array of numbers.
 
 ### load()
 
-> **load**(`model`, `onDownloadProgressCallback`): `Promise`\<`void`\>
+> **load**(`model`, `onDownloadProgressCallback?`): `Promise`\<`void`\>
 
 Defined in: [modules/computer_vision/ClassificationModule.ts:21](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/computer_vision/ClassificationModule.ts#L21)
 
@@ -240,7 +240,7 @@ Object containing `modelSource`.
 
 [`ResourceSource`](../type-aliases/ResourceSource.md)
 
-##### onDownloadProgressCallback
+##### onDownloadProgressCallback?
 
 (`progress`) => `void`
 
diff --git a/docs/docs/06-api-reference/classes/ExecutorchModule.md b/docs/docs/06-api-reference/classes/ExecutorchModule.md
@@ -224,7 +224,7 @@ The input shape as an array of numbers.
 
 ### load()
 
-> **load**(`modelSource`, `onDownloadProgressCallback`): `Promise`\<`void`\>
+> **load**(`modelSource`, `onDownloadProgressCallback?`): `Promise`\<`void`\>
 
 Defined in: [modules/general/ExecutorchModule.ts:22](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/general/ExecutorchModule.ts#L22)
 
@@ -239,7 +239,7 @@ Optionally accepts a download progress callback.
 
 Source of the model to be loaded.
 
-##### onDownloadProgressCallback
+##### onDownloadProgressCallback?
 
 (`progress`) => `void`
 
diff --git a/docs/docs/06-api-reference/classes/ImageEmbeddingsModule.md b/docs/docs/06-api-reference/classes/ImageEmbeddingsModule.md
@@ -223,7 +223,7 @@ The input shape as an array of numbers.
 
 ### load()
 
-> **load**(`model`, `onDownloadProgressCallback`): `Promise`\<`void`\>
+> **load**(`model`, `onDownloadProgressCallback?`): `Promise`\<`void`\>
 
 Defined in: [modules/computer_vision/ImageEmbeddingsModule.ts:20](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/computer_vision/ImageEmbeddingsModule.ts#L20)
 
@@ -239,7 +239,7 @@ Object containing `modelSource`.
 
 [`ResourceSource`](../type-aliases/ResourceSource.md)
 
-##### onDownloadProgressCallback
+##### onDownloadProgressCallback?
 
 (`progress`) => `void`
 
diff --git a/docs/docs/06-api-reference/classes/LLMModule.md b/docs/docs/06-api-reference/classes/LLMModule.md
@@ -8,15 +8,15 @@ Module for managing a Large Language Model (LLM) instance.
 
 ### Constructor
 
-> **new LLMModule**(`optionalCallbacks`): `LLMModule`
+> **new LLMModule**(`optionalCallbacks?`): `LLMModule`
 
 Defined in: [modules/natural_language_processing/LLMModule.ts:20](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L20)
 
 Creates a new instance of `LLMModule` with optional callbacks.
 
 #### Parameters
 
-##### optionalCallbacks
+##### optionalCallbacks?
 
 Object containing optional callbacks.
 
@@ -227,7 +227,7 @@ Interrupts model generation. It may return one more token after interrupt.
 
 ### load()
 
-> **load**(`model`, `onDownloadProgressCallback`): `Promise`\<`void`\>
+> **load**(`model`, `onDownloadProgressCallback?`): `Promise`\<`void`\>
 
 Defined in: [modules/natural_language_processing/LLMModule.ts:49](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/natural_language_processing/LLMModule.ts#L49)
 
@@ -257,7 +257,7 @@ Object containing model, tokenizer, and tokenizer config sources.
 
 `ResourceSource` pointing to the JSON file which contains the tokenizer.
 
-##### onDownloadProgressCallback
+##### onDownloadProgressCallback?
 
 (`progress`) => `void`
 
diff --git a/docs/docs/06-api-reference/classes/MessageCountContextStrategy.md b/docs/docs/06-api-reference/classes/MessageCountContextStrategy.md
@@ -13,7 +13,7 @@ This strategy trims the conversation history based purely on the message count.
 
 ### Constructor
 
-> **new MessageCountContextStrategy**(`windowLength`): `MessageCountContextStrategy`
+> **new MessageCountContextStrategy**(`windowLength?`): `MessageCountContextStrategy`
 
 Defined in: [utils/llms/context_strategy/MessageCountContextStrategy.ts:14](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/utils/llms/context_strategy/MessageCountContextStrategy.ts#L14)
 
@@ -23,7 +23,7 @@ Initializes the MessageCountContextStrategy.
 
 #### Parameters
 
-##### windowLength
+##### windowLength?
 
 `number` = `5`
 
diff --git a/docs/docs/06-api-reference/classes/OCRModule.md b/docs/docs/06-api-reference/classes/OCRModule.md
@@ -59,7 +59,7 @@ The OCR result as a `OCRDetection[]`.
 
 ### load()
 
-> **load**(`model`, `onDownloadProgressCallback`): `Promise`\<`void`\>
+> **load**(`model`, `onDownloadProgressCallback?`): `Promise`\<`void`\>
 
 Defined in: [modules/computer_vision/OCRModule.ts:27](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/computer_vision/OCRModule.ts#L27)
 
@@ -85,7 +85,7 @@ Object containing `detectorSource`, `recognizerSource`, and `language`.
 
 [`ResourceSource`](../type-aliases/ResourceSource.md)
 
-##### onDownloadProgressCallback
+##### onDownloadProgressCallback?
 
 (`progress`) => `void`
 
diff --git a/docs/docs/06-api-reference/classes/ObjectDetectionModule.md b/docs/docs/06-api-reference/classes/ObjectDetectionModule.md
@@ -180,7 +180,7 @@ Always call this method when you're done with a model to prevent memory leaks.
 
 ### forward()
 
-> **forward**(`input`, `detectionThreshold`): `Promise`\<[`Detection`](../interfaces/Detection.md)[]\>
+> **forward**(`input`, `detectionThreshold?`): `Promise`\<[`Detection`](../interfaces/Detection.md)[]\>
 
 Defined in: [modules/computer_vision/ObjectDetectionModule.ts:46](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/computer_vision/ObjectDetectionModule.ts#L46)
 
@@ -202,7 +202,7 @@ Image source (string path or PixelData object)
 
 `string` | [`PixelData`](../interfaces/PixelData.md)
 
-##### detectionThreshold
+##### detectionThreshold?
 
 `number` = `0.5`
 
@@ -308,7 +308,7 @@ The input shape as an array of numbers.
 
 ### load()
 
-> **load**(`model`, `onDownloadProgressCallback`): `Promise`\<`void`\>
+> **load**(`model`, `onDownloadProgressCallback?`): `Promise`\<`void`\>
 
 Defined in: [modules/computer_vision/ObjectDetectionModule.ts:22](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/computer_vision/ObjectDetectionModule.ts#L22)
 
@@ -325,7 +325,7 @@ Object containing `modelSource`.
 
 [`ResourceSource`](../type-aliases/ResourceSource.md)
 
-##### onDownloadProgressCallback
+##### onDownloadProgressCallback?
 
 (`progress`) => `void`
 
diff --git a/docs/docs/06-api-reference/classes/ResourceFetcher.md b/docs/docs/06-api-reference/classes/ResourceFetcher.md
@@ -58,15 +58,15 @@ Currently supports reading file contents as strings for configuration files.
 
 ### fetch()
 
-> `static` **fetch**(`callback`, ...`sources`): `Promise`\<`string`[] \| `null`\>
+> `static` **fetch**(`callback?`, ...`sources`): `Promise`\<`string`[] \| `null`\>
 
 Defined in: [utils/ResourceFetcher.ts:105](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/utils/ResourceFetcher.ts#L105)
 
 Fetches resources (remote URLs, local files or embedded assets), downloads or stores them locally for use by React Native ExecuTorch.
 
 #### Parameters
 
-##### callback
+##### callback?
 
 (`downloadProgress`) => `void`
 
diff --git a/docs/docs/06-api-reference/classes/SemanticSegmentationModule.md b/docs/docs/06-api-reference/classes/SemanticSegmentationModule.md
@@ -131,7 +131,7 @@ Always call this method when you're done with a model to prevent memory leaks.
 
 ### forward()
 
-> **forward**\<`K`\>(`imageSource`, `classesOfInterest`, `resizeToInput`): `Promise`\<`Record`\<`"ARGMAX"`, `Int32Array`\<`ArrayBufferLike`\>\> & `Record`\<`K`, `Float32Array`\<`ArrayBufferLike`\>\>\>
+> **forward**\<`K`\>(`imageSource`, `classesOfInterest?`, `resizeToInput?`): `Promise`\<`Record`\<`"ARGMAX"`, `Int32Array`\<`ArrayBufferLike`\>\> & `Record`\<`K`, `Float32Array`\<`ArrayBufferLike`\>\>\>
 
 Defined in: [modules/computer_vision/SemanticSegmentationModule.ts:176](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/computer_vision/SemanticSegmentationModule.ts#L176)
 
@@ -151,13 +151,13 @@ Executes the model's forward pass to perform semantic segmentation on the provid
 
 A string representing the image source (e.g., a file path, URI, or Base64-encoded string).
 
-##### classesOfInterest
+##### classesOfInterest?
 
 `K`[] = `[]`
 
 An optional list of label keys indicating which per-class probability masks to include in the output. `ARGMAX` is always returned regardless.
 
-##### resizeToInput
+##### resizeToInput?
 
 `boolean` = `true`
 
@@ -260,7 +260,7 @@ Load the model and prepare it for inference.
 
 ### fromCustomConfig()
 
-> `static` **fromCustomConfig**\<`L`\>(`modelSource`, `config`, `onDownloadProgress`): `Promise`\<`SemanticSegmentationModule`\<`L`\>\>
+> `static` **fromCustomConfig**\<`L`\>(`modelSource`, `config`, `onDownloadProgress?`): `Promise`\<`SemanticSegmentationModule`\<`L`\>\>
 
 Defined in: [modules/computer_vision/SemanticSegmentationModule.ts:142](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/computer_vision/SemanticSegmentationModule.ts#L142)
 
@@ -287,7 +287,7 @@ A fetchable resource pointing to the model binary.
 
 A [SemanticSegmentationConfig](../type-aliases/SemanticSegmentationConfig.md) object with the label map and optional preprocessing parameters.
 
-##### onDownloadProgress
+##### onDownloadProgress?
 
 (`progress`) => `void`
 
@@ -313,7 +313,7 @@ const segmentation = await SemanticSegmentationModule.fromCustomConfig(
 
 ### fromModelName()
 
-> `static` **fromModelName**\<`C`\>(`config`, `onDownloadProgress`): `Promise`\<`SemanticSegmentationModule`\<[`ModelNameOf`](../type-aliases/ModelNameOf.md)\<`C`\>\>\>
+> `static` **fromModelName**\<`C`\>(`config`, `onDownloadProgress?`): `Promise`\<`SemanticSegmentationModule`\<[`ModelNameOf`](../type-aliases/ModelNameOf.md)\<`C`\>\>\>
 
 Defined in: [modules/computer_vision/SemanticSegmentationModule.ts:95](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/computer_vision/SemanticSegmentationModule.ts#L95)
 
@@ -334,7 +334,7 @@ The config object is discriminated by `modelName` — each model can require dif
 
 A [SemanticSegmentationModelSources](../type-aliases/SemanticSegmentationModelSources.md) object specifying which model to load and where to fetch it from.
 
-##### onDownloadProgress
+##### onDownloadProgress?
 
 (`progress`) => `void`
 
diff --git a/docs/docs/06-api-reference/classes/SlidingWindowContextStrategy.md b/docs/docs/06-api-reference/classes/SlidingWindowContextStrategy.md
@@ -17,7 +17,7 @@ to ensure it fits within the model's physical context limits.
 
 ### Constructor
 
-> **new SlidingWindowContextStrategy**(`bufferTokens`, `allowOrphanedAssistantMessages`): `SlidingWindowContextStrategy`
+> **new SlidingWindowContextStrategy**(`bufferTokens`, `allowOrphanedAssistantMessages?`): `SlidingWindowContextStrategy`
 
 Defined in: [utils/llms/context_strategy/SlidingWindowContextStrategy.ts:19](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/utils/llms/context_strategy/SlidingWindowContextStrategy.ts#L19)
 
@@ -31,7 +31,7 @@ Initializes the SlidingWindowContextStrategy.
 
 The number of tokens to keep free for the model's generated response (e.g., 1000).
 
-##### allowOrphanedAssistantMessages
+##### allowOrphanedAssistantMessages?
 
 `boolean` = `false`
 
diff --git a/docs/docs/06-api-reference/classes/SpeechToTextModule.md b/docs/docs/06-api-reference/classes/SpeechToTextModule.md
@@ -87,7 +87,7 @@ The encoded output.
 
 ### load()
 
-> **load**(`model`, `onDownloadProgressCallback`): `Promise`\<`void`\>
+> **load**(`model`, `onDownloadProgressCallback?`): `Promise`\<`void`\>
 
 Defined in: [modules/natural_language_processing/SpeechToTextModule.ts:27](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L27)
 
@@ -102,7 +102,7 @@ Loads the model specified by the config object.
 
 Configuration object containing model sources.
 
-##### onDownloadProgressCallback
+##### onDownloadProgressCallback?
 
 (`progress`) => `void`
 
@@ -116,7 +116,7 @@ Optional callback to monitor download progress.
 
 ### stream()
 
-> **stream**(`options`): `AsyncGenerator`\<\{ `committed`: [`TranscriptionResult`](../interfaces/TranscriptionResult.md); `nonCommitted`: [`TranscriptionResult`](../interfaces/TranscriptionResult.md); \}\>
+> **stream**(`options?`): `AsyncGenerator`\<\{ `committed`: [`TranscriptionResult`](../interfaces/TranscriptionResult.md); `nonCommitted`: [`TranscriptionResult`](../interfaces/TranscriptionResult.md); \}\>
 
 Defined in: [modules/natural_language_processing/SpeechToTextModule.ts:133](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L133)
 
@@ -130,7 +130,7 @@ Use with `streamInsert` and `streamStop` to control the stream.
 
 #### Parameters
 
-##### options
+##### options?
 
 [`DecodingOptions`](../interfaces/DecodingOptions.md) = `{}`
 
@@ -182,7 +182,7 @@ Stops the current streaming transcription session.
 
 ### transcribe()
 
-> **transcribe**(`waveform`, `options`): `Promise`\<[`TranscriptionResult`](../interfaces/TranscriptionResult.md)\>
+> **transcribe**(`waveform`, `options?`): `Promise`\<[`TranscriptionResult`](../interfaces/TranscriptionResult.md)\>
 
 Defined in: [modules/natural_language_processing/SpeechToTextModule.ts:109](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/natural_language_processing/SpeechToTextModule.ts#L109)
 
@@ -198,7 +198,7 @@ Returns the transcription as a string. Passing `number[]` is deprecated.
 
 The Float32Array audio data.
 
-##### options
+##### options?
 
 [`DecodingOptions`](../interfaces/DecodingOptions.md) = `{}`
 
diff --git a/docs/docs/06-api-reference/classes/StyleTransferModule.md b/docs/docs/06-api-reference/classes/StyleTransferModule.md
@@ -223,7 +223,7 @@ The input shape as an array of numbers.
 
 ### load()
 
-> **load**(`model`, `onDownloadProgressCallback`): `Promise`\<`void`\>
+> **load**(`model`, `onDownloadProgressCallback?`): `Promise`\<`void`\>
 
 Defined in: [modules/computer_vision/StyleTransferModule.ts:21](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/computer_vision/StyleTransferModule.ts#L21)
 
@@ -240,7 +240,7 @@ Object containing `modelSource`.
 
 [`ResourceSource`](../type-aliases/ResourceSource.md)
 
-##### onDownloadProgressCallback
+##### onDownloadProgressCallback?
 
 (`progress`) => `void`
 
diff --git a/docs/docs/06-api-reference/classes/TextEmbeddingsModule.md b/docs/docs/06-api-reference/classes/TextEmbeddingsModule.md
@@ -223,7 +223,7 @@ The input shape as an array of numbers.
 
 ### load()
 
-> **load**(`model`, `onDownloadProgressCallback`): `Promise`\<`void`\>
+> **load**(`model`, `onDownloadProgressCallback?`): `Promise`\<`void`\>
 
 Defined in: [modules/natural_language_processing/TextEmbeddingsModule.ts:22](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/natural_language_processing/TextEmbeddingsModule.ts#L22)
 
@@ -247,7 +247,7 @@ Object containing model and tokenizer sources.
 
 `ResourceSource` that specifies the location of the tokenizer JSON file.
 
-##### onDownloadProgressCallback
+##### onDownloadProgressCallback?
 
 (`progress`) => `void`
 
diff --git a/docs/docs/06-api-reference/classes/TextToImageModule.md b/docs/docs/06-api-reference/classes/TextToImageModule.md
@@ -146,7 +146,7 @@ Always call this method when you're done with a model to prevent memory leaks.
 
 ### forward()
 
-> **forward**(`input`, `imageSize`, `numSteps`, `seed?`): `Promise`\<`string`\>
+> **forward**(`input`, `imageSize?`, `numSteps?`, `seed?`): `Promise`\<`string`\>
 
 Defined in: [modules/computer_vision/TextToImageModule.ts:106](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/computer_vision/TextToImageModule.ts#L106)
 
@@ -161,13 +161,13 @@ The resulting image, with dimensions `imageSize`×`imageSize` pixels, is returne
 
 The text prompt to generate the image from.
 
-##### imageSize
+##### imageSize?
 
 `number` = `512`
 
 The desired width and height of the output image in pixels.
 
-##### numSteps
+##### numSteps?
 
 `number` = `5`
 
@@ -268,7 +268,7 @@ Interrupts model generation. The model is stopped in the nearest step.
 
 ### load()
 
-> **load**(`model`, `onDownloadProgressCallback`): `Promise`\<`void`\>
+> **load**(`model`, `onDownloadProgressCallback?`): `Promise`\<`void`\>
 
 Defined in: [modules/computer_vision/TextToImageModule.ts:36](https://github.com/software-mansion/react-native-executorch/blob/main/packages/react-native-executorch/src/modules/computer_vision/TextToImageModule.ts#L36)
 
@@ -300,7 +300,7 @@ Object containing sources for tokenizer, scheduler, encoder, unet, and decoder.
 
 [`ResourceSource`](../type-aliases/ResourceSource.md)
 
-##### onDownloadProgressCallback
+##### onDownloadProgressCallback?
 
 (`progress`) => `void`
 
diff --git a/docs/docs/06-api-reference/classes/TextToSpeechModule.md b/docs/docs/06-api-reference/classes/TextToSpeechModule.md
diff --git a/docs/docs/06-api-reference/classes/TokenizerModule.md b/docs/docs/06-api-reference/classes/TokenizerModule.md
diff --git a/docs/docs/06-api-reference/classes/VADModule.md b/docs/docs/06-api-reference/classes/VADModule.md
diff --git a/docs/docs/06-api-reference/classes/VerticalOCRModule.md b/docs/docs/06-api-reference/classes/VerticalOCRModule.md
