@callstack/repack-dev-server 1.0.0-next.2 → 1.0.0-next.3

package/docs/interfaces/HmrDelegate.md

@@ -1,51 +0,0 @@
-# Interface: HmrDelegate
-
-Delegate with implementation for HMR-specific functions.
-
-## Table of contents
-
-### Methods
-
-- [getUriPath](HmrDelegate.md#geturipath)
-- [onClientConnected](HmrDelegate.md#onclientconnected)
-
-## Methods
-
-### getUriPath
-
-▸ **getUriPath**(): `string`
-
-Get URI under which HMR server will be running, e.g: `/hmr`
-
-#### Returns
-
-`string`
-
-#### Defined in
-
-[plugins/wss/types.ts:6](https://github.com/callstack/repack/blob/a067171/packages/dev-server/src/plugins/wss/types.ts#L6)
-
-___
-
-### onClientConnected
-
-▸ **onClientConnected**(`platform`, `clientId`): `void`
-
-Callback for when the new HMR client is connected.
-
-Useful for running initial synchronization or any other side effect.
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `platform` | `string` | Platform of the connected client. |
-| `clientId` | `string` | Id of the connected client. |
-
-#### Returns
-
-`void`
-
-#### Defined in
-
-[plugins/wss/types.ts:16](https://github.com/callstack/repack/blob/a067171/packages/dev-server/src/plugins/wss/types.ts#L16)

package/docs/interfaces/InputStackFrame.md

@@ -1,76 +0,0 @@
-# Interface: InputStackFrame
-
-React Native stack frame used as input when processing by {@link Symbolicator}.
-
-## Hierarchy
-
-- [`ReactNativeStackFrame`](ReactNativeStackFrame.md)
-
-  ↳ **`InputStackFrame`**
-
-  ↳↳ [`StackFrame`](StackFrame.md)
-
-## Table of contents
-
-### Properties
-
-- [column](InputStackFrame.md#column)
-- [file](InputStackFrame.md#file)
-- [lineNumber](InputStackFrame.md#linenumber)
-- [methodName](InputStackFrame.md#methodname)
-
-## Properties
-
-### column
-
-• **column**: ``null`` \| `number`
-
-#### Inherited from
-
-[ReactNativeStackFrame](ReactNativeStackFrame.md).[column](ReactNativeStackFrame.md#column)
-
-#### Defined in
-
-[plugins/symbolicate/types.ts:6](https://github.com/callstack/repack/blob/a067171/packages/dev-server/src/plugins/symbolicate/types.ts#L6)
-
-___
-
-### file
-
-• **file**: `string`
-
-#### Overrides
-
-[ReactNativeStackFrame](ReactNativeStackFrame.md).[file](ReactNativeStackFrame.md#file)
-
-#### Defined in
-
-[plugins/symbolicate/types.ts:15](https://github.com/callstack/repack/blob/a067171/packages/dev-server/src/plugins/symbolicate/types.ts#L15)
-
-___
-
-### lineNumber
-
-• **lineNumber**: ``null`` \| `number`
-
-#### Inherited from
-
-[ReactNativeStackFrame](ReactNativeStackFrame.md).[lineNumber](ReactNativeStackFrame.md#linenumber)
-
-#### Defined in
-
-[plugins/symbolicate/types.ts:5](https://github.com/callstack/repack/blob/a067171/packages/dev-server/src/plugins/symbolicate/types.ts#L5)
-
-___
-
-### methodName
-
-• **methodName**: `string`
-
-#### Inherited from
-
-[ReactNativeStackFrame](ReactNativeStackFrame.md).[methodName](ReactNativeStackFrame.md#methodname)
-
-#### Defined in
-
-[plugins/symbolicate/types.ts:8](https://github.com/callstack/repack/blob/a067171/packages/dev-server/src/plugins/symbolicate/types.ts#L8)

package/docs/interfaces/ProgressData.md

@@ -1,34 +0,0 @@
-# Interface: ProgressData
-
-Representation of the compilation progress.
-
-## Table of contents
-
-### Properties
-
-- [completed](ProgressData.md#completed)
-- [total](ProgressData.md#total)
-
-## Properties
-
-### completed
-
-• **completed**: `number`
-
-Number of modules built.
-
-#### Defined in
-
-[types.ts:178](https://github.com/callstack/repack/blob/a067171/packages/dev-server/src/types.ts#L178)
-
-___
-
-### total
-
-• **total**: `number`
-
-Total number of modules detect as part of compilation.
-
-#### Defined in
-
-[types.ts:181](https://github.com/callstack/repack/blob/a067171/packages/dev-server/src/types.ts#L181)

package/docs/interfaces/ReactNativeStackFrame.md

@@ -1,58 +0,0 @@
-# Interface: ReactNativeStackFrame
-
-Raw React Native stack frame.
-
-## Hierarchy
-
-- **`ReactNativeStackFrame`**
-
-  ↳ [`InputStackFrame`](InputStackFrame.md)
-
-## Table of contents
-
-### Properties
-
-- [column](ReactNativeStackFrame.md#column)
-- [file](ReactNativeStackFrame.md#file)
-- [lineNumber](ReactNativeStackFrame.md#linenumber)
-- [methodName](ReactNativeStackFrame.md#methodname)
-
-## Properties
-
-### column
-
-• **column**: ``null`` \| `number`
-
-#### Defined in
-
-[plugins/symbolicate/types.ts:6](https://github.com/callstack/repack/blob/a067171/packages/dev-server/src/plugins/symbolicate/types.ts#L6)
-
-___
-
-### file
-
-• **file**: ``null`` \| `string`
-
-#### Defined in
-
-[plugins/symbolicate/types.ts:7](https://github.com/callstack/repack/blob/a067171/packages/dev-server/src/plugins/symbolicate/types.ts#L7)
-
-___
-
-### lineNumber
-
-• **lineNumber**: ``null`` \| `number`
-
-#### Defined in
-
-[plugins/symbolicate/types.ts:5](https://github.com/callstack/repack/blob/a067171/packages/dev-server/src/plugins/symbolicate/types.ts#L5)
-
-___
-
-### methodName
-
-• **methodName**: `string`
-
-#### Defined in
-
-[plugins/symbolicate/types.ts:8](https://github.com/callstack/repack/blob/a067171/packages/dev-server/src/plugins/symbolicate/types.ts#L8)

package/docs/interfaces/Server.Api.Asset.md

@@ -1,36 +0,0 @@
-# Interface: Asset
-
-[Server](../modules/Server.md).[Api](../modules/Server.Api.md).Asset
-
-A compilation asset representation for API clients.
-
-## Indexable
-
-▪ [key: `string`]: `any`
-
-## Table of contents
-
-### Properties
-
-- [name](Server.Api.Asset.md#name)
-- [size](Server.Api.Asset.md#size)
-
-## Properties
-
-### name
-
-• **name**: `string`
-
-#### Defined in
-
-[types.ts:141](https://github.com/callstack/repack/blob/a067171/packages/dev-server/src/types.ts#L141)
-
-___
-
-### size
-
-• **size**: `number`
-
-#### Defined in
-
-[types.ts:142](https://github.com/callstack/repack/blob/a067171/packages/dev-server/src/types.ts#L142)

package/docs/interfaces/Server.Api.CompilationStats.md

@@ -1,9 +0,0 @@
-# Interface: CompilationStats
-
-[Server](../modules/Server.md).[Api](../modules/Server.Api.md).CompilationStats
-
-A compilation stats representation for API clients.
-
-## Indexable
-
-▪ [key: `string`]: `any`

package/docs/interfaces/Server.Api.Delegate.md

@@ -1,75 +0,0 @@
-# Interface: Delegate
-
-[Server](../modules/Server.md).[Api](../modules/Server.Api.md).Delegate
-
-Delegate with implementation for API endpoints.
-
-## Table of contents
-
-### Methods
-
-- [getAssets](Server.Api.Delegate.md#getassets)
-- [getCompilationStats](Server.Api.Delegate.md#getcompilationstats)
-- [getPlatforms](Server.Api.Delegate.md#getplatforms)
-
-## Methods
-
-### getAssets
-
-▸ **getAssets**(`platform`): `Promise`<[`Asset`](Server.Api.Asset.md)[]\>
-
-Get all assets from compilation for given platform.
-Should return `[]` if the compilation does not exists for given platform.
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `platform` | `string` |
-
-#### Returns
-
-`Promise`<[`Asset`](Server.Api.Asset.md)[]\>
-
-#### Defined in
-
-[types.ts:162](https://github.com/callstack/repack/blob/a067171/packages/dev-server/src/types.ts#L162)
-
-___
-
-### getCompilationStats
-
-▸ **getCompilationStats**(`platform`): `Promise`<``null`` \| [`CompilationStats`](Server.Api.CompilationStats.md)\>
-
-Get compilation stats for a given platform.
-Should return `null` if the compilation does not exists for given platform.
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `platform` | `string` |
-
-#### Returns
-
-`Promise`<``null`` \| [`CompilationStats`](Server.Api.CompilationStats.md)\>
-
-#### Defined in
-
-[types.ts:168](https://github.com/callstack/repack/blob/a067171/packages/dev-server/src/types.ts#L168)
-
-___
-
-### getPlatforms
-
-▸ **getPlatforms**(): `Promise`<`string`[]\>
-
-Get all platforms - either with already existing compilations or all supported platforms.
-
-#### Returns
-
-`Promise`<`string`[]\>
-
-#### Defined in
-
-[types.ts:156](https://github.com/callstack/repack/blob/a067171/packages/dev-server/src/types.ts#L156)

package/docs/interfaces/Server.Config.md

@@ -1,49 +0,0 @@
-# Interface: Config
-
-[Server](../modules/Server.md).Config
-
-Development server configuration.
-
-## Table of contents
-
-### Properties
-
-- [options](Server.Config.md#options)
-
-### Methods
-
-- [delegate](Server.Config.md#delegate)
-
-## Properties
-
-### options
-
-• **options**: [`Options`](Server.Options.md)
-
-Development server options to configure e.g: `port`, `host` etc.
-
-#### Defined in
-
-[types.ts:21](https://github.com/callstack/repack/blob/a067171/packages/dev-server/src/types.ts#L21)
-
-## Methods
-
-### delegate
-
-▸ **delegate**(`context`): [`Delegate`](Server.Delegate.md)
-
-Function to create a delegate, which implements crucial functionalities.
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `context` | [`DelegateContext`](Server.DelegateContext.md) |
-
-#### Returns
-
-[`Delegate`](Server.Delegate.md)
-
-#### Defined in
-
-[types.ts:24](https://github.com/callstack/repack/blob/a067171/packages/dev-server/src/types.ts#L24)

package/docs/interfaces/Server.Delegate.md

@@ -1,88 +0,0 @@
-# Interface: Delegate
-
-[Server](../modules/Server.md).Delegate
-
-A complete delegate with implementations for all server functionalities.
-
-## Table of contents
-
-### Properties
-
-- [api](Server.Delegate.md#api)
-- [compiler](Server.Delegate.md#compiler)
-- [hmr](Server.Delegate.md#hmr)
-- [logger](Server.Delegate.md#logger)
-- [messages](Server.Delegate.md#messages)
-- [symbolicator](Server.Delegate.md#symbolicator)
-
-## Properties
-
-### api
-
-• `Optional` **api**: [`Delegate`](Server.Api.Delegate.md)
-
-An API delegate.
-
-#### Defined in
-
-[types.ts:71](https://github.com/callstack/repack/blob/a067171/packages/dev-server/src/types.ts#L71)
-
-___
-
-### compiler
-
-• **compiler**: [`CompilerDelegate`](CompilerDelegate.md)
-
-A compiler delegate.
-
-#### Defined in
-
-[types.ts:56](https://github.com/callstack/repack/blob/a067171/packages/dev-server/src/types.ts#L56)
-
-___
-
-### hmr
-
-• **hmr**: [`HmrDelegate`](HmrDelegate.md)
-
-An HMR delegate.
-
-#### Defined in
-
-[types.ts:65](https://github.com/callstack/repack/blob/a067171/packages/dev-server/src/types.ts#L65)
-
-___
-
-### logger
-
-• **logger**: [`LoggerDelegate`](Server.LoggerDelegate.md)
-
-A logger delegate.
-
-#### Defined in
-
-[types.ts:62](https://github.com/callstack/repack/blob/a067171/packages/dev-server/src/types.ts#L62)
-
-___
-
-### messages
-
-• **messages**: [`MessagesDelegate`](Server.MessagesDelegate.md)
-
-An messages delegate.
-
-#### Defined in
-
-[types.ts:68](https://github.com/callstack/repack/blob/a067171/packages/dev-server/src/types.ts#L68)
-
-___
-
-### symbolicator
-
-• **symbolicator**: [`SymbolicatorDelegate`](SymbolicatorDelegate.md)
-
-A symbolicator delegate.
-
-#### Defined in
-
-[types.ts:59](https://github.com/callstack/repack/blob/a067171/packages/dev-server/src/types.ts#L59)

package/docs/interfaces/Server.DelegateContext.md

@@ -1,134 +0,0 @@
-# Interface: DelegateContext
-
-[Server](../modules/Server.md).DelegateContext
-
-A delegate context used in `delegate` builder in [Config](Server.Config.md).
-
-Allows to emit logs, notify about compilation events and broadcast events to connected clients.
-
-## Table of contents
-
-### Properties
-
-- [log](Server.DelegateContext.md#log)
-
-### Methods
-
-- [broadcastToHmrClients](Server.DelegateContext.md#broadcasttohmrclients)
-- [broadcastToMessageClients](Server.DelegateContext.md#broadcasttomessageclients)
-- [notifyBuildEnd](Server.DelegateContext.md#notifybuildend)
-- [notifyBuildStart](Server.DelegateContext.md#notifybuildstart)
-
-## Properties
-
-### log
-
-• **log**: `FastifyLoggerInstance`
-
-A logger instance, useful for emitting logs from the delegate.
-
-#### Defined in
-
-[types.ts:81](https://github.com/callstack/repack/blob/a067171/packages/dev-server/src/types.ts#L81)
-
-## Methods
-
-### broadcastToHmrClients
-
-▸ **broadcastToHmrClients**<`E`\>(`event`, `platform`, `clientIds?`): `void`
-
-Broadcast arbitrary event to all connected HMR clients for given `platform`.
-
-#### Type parameters
-
-| Name | Type |
-| :------ | :------ |
-| `E` | `any` |
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `event` | `E` | Arbitrary event to broadcast. |
-| `platform` | `string` | Platform of the clients to which broadcast should be sent. |
-| `clientIds?` | `string`[] | Ids of the client to which broadcast should be sent. If `undefined` the broadcast will be sent to all connected clients for the given `platform`. |
-
-#### Returns
-
-`void`
-
-#### Defined in
-
-[types.ts:97](https://github.com/callstack/repack/blob/a067171/packages/dev-server/src/types.ts#L97)
-
-___
-
-### broadcastToMessageClients
-
-▸ **broadcastToMessageClients**<`E`\>(`event`): `void`
-
-Broadcast arbitrary method-like event to all connected message clients.
-
-#### Type parameters
-
-| Name | Type |
-| :------ | :------ |
-| `E` | extends `Object` |
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `event` | `E` | Arbitrary method-like event to broadcast. |
-
-#### Returns
-
-`void`
-
-#### Defined in
-
-[types.ts:108](https://github.com/callstack/repack/blob/a067171/packages/dev-server/src/types.ts#L108)
-
-___
-
-### notifyBuildEnd
-
-▸ **notifyBuildEnd**(`platform`): `void`
-
-Send notification about compilation end for given `platform`.
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `platform` | `string` |
-
-#### Returns
-
-`void`
-
-#### Defined in
-
-[types.ts:87](https://github.com/callstack/repack/blob/a067171/packages/dev-server/src/types.ts#L87)
-
-___
-
-### notifyBuildStart
-
-▸ **notifyBuildStart**(`platform`): `void`
-
-Send notification about compilation start for given `platform`.
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `platform` | `string` |
-
-#### Returns
-
-`void`
-
-#### Defined in
-
-[types.ts:84](https://github.com/callstack/repack/blob/a067171/packages/dev-server/src/types.ts#L84)

package/docs/interfaces/Server.LoggerDelegate.md

@@ -1,33 +0,0 @@
-# Interface: LoggerDelegate
-
-[Server](../modules/Server.md).LoggerDelegate
-
-Delegate with implementation for logging functions.
-
-## Table of contents
-
-### Methods
-
-- [onMessage](Server.LoggerDelegate.md#onmessage)
-
-## Methods
-
-### onMessage
-
-▸ **onMessage**(`log`): `void`
-
-Callback for when a new log is emitted.
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `log` | `any` | An object with log data. |
-
-#### Returns
-
-`void`
-
-#### Defined in
-
-[types.ts:124](https://github.com/callstack/repack/blob/a067171/packages/dev-server/src/types.ts#L124)

package/docs/interfaces/Server.MessagesDelegate.md

@@ -1,44 +0,0 @@
-# Interface: MessagesDelegate
-
-[Server](../modules/Server.md).MessagesDelegate
-
-Delegate with implementation for messages used in route handlers.
-
-## Table of contents
-
-### Methods
-
-- [getHello](Server.MessagesDelegate.md#gethello)
-- [getStatus](Server.MessagesDelegate.md#getstatus)
-
-## Methods
-
-### getHello
-
-▸ **getHello**(): `string`
-
-Get message to send as a reply for `GET /` route.
-
-#### Returns
-
-`string`
-
-#### Defined in
-
-[types.ts:132](https://github.com/callstack/repack/blob/a067171/packages/dev-server/src/types.ts#L132)
-
-___
-
-### getStatus
-
-▸ **getStatus**(): `string`
-
-Get message to send as a reply for `GET /status` route.
-
-#### Returns
-
-`string`
-
-#### Defined in
-
-[types.ts:135](https://github.com/callstack/repack/blob/a067171/packages/dev-server/src/types.ts#L135)