@callstack/repack-dev-server 1.0.2 → 4.0.0-rc.0

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/81f067f/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/81f067f/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/81f067f/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/81f067f/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/81f067f/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/81f067f/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/81f067f/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/81f067f/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/81f067f/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/81f067f/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/81f067f/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/81f067f/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/81f067f/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/81f067f/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/81f067f/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/81f067f/packages/dev-server/src/types.ts#L135)

package/docs/interfaces/Server.Options.md

@@ -1,70 +0,0 @@
-# Interface: Options
-
-[Server](../modules/Server.md).Options
-
-Development server options.
-
-## Table of contents
-
-### Properties
-
-- [host](Server.Options.md#host)
-- [https](Server.Options.md#https)
-- [port](Server.Options.md#port)
-- [rootDir](Server.Options.md#rootdir)
-
-## Properties
-
-### host
-
-• `Optional` **host**: `string`
-
-Hostname or IP address under which to run the development server.
-When left unspecified, it will listen on all available network interfaces, similarly to listening on '0.0.0.0'.
-
-#### Defined in
-
-[types.ts:39](https://github.com/callstack/repack/blob/81f067f/packages/dev-server/src/types.ts#L39)
-
-___
-
-### https
-
-• `Optional` **https**: `Object`
-
-Options for running the server as HTTPS. If `undefined`, the server will run as HTTP.
-
-#### Type declaration
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `cert?` | `string` | Path to certificate when running server as HTTPS. |
-| `key?` | `string` | Path to certificate key when running server as HTTPS. |
-
-#### Defined in
-
-[types.ts:42](https://github.com/callstack/repack/blob/81f067f/packages/dev-server/src/types.ts#L42)
-
-___
-
-### port
-
-• **port**: `number`
-
-Port under which to run the development server.
-
-#### Defined in
-
-[types.ts:33](https://github.com/callstack/repack/blob/81f067f/packages/dev-server/src/types.ts#L33)
-
-___
-
-### rootDir
-
-• **rootDir**: `string`
-
-Root directory of the project.
-
-#### Defined in
-
-[types.ts:30](https://github.com/callstack/repack/blob/81f067f/packages/dev-server/src/types.ts#L30)

package/docs/interfaces/StackFrame.md

@@ -1,85 +0,0 @@
-# Interface: StackFrame
-
-Final symbolicated stack frame.
-
-## Hierarchy
-
-- [`InputStackFrame`](InputStackFrame.md)
-
-  ↳ **`StackFrame`**
-
-## Table of contents
-
-### Properties
-
-- [collapse](StackFrame.md#collapse)
-- [column](StackFrame.md#column)
-- [file](StackFrame.md#file)
-- [lineNumber](StackFrame.md#linenumber)
-- [methodName](StackFrame.md#methodname)
-
-## Properties
-
-### collapse
-
-• **collapse**: `boolean`
-
-#### Defined in
-
-[plugins/symbolicate/types.ts:22](https://github.com/callstack/repack/blob/81f067f/packages/dev-server/src/plugins/symbolicate/types.ts#L22)
-
-___
-
-### column
-
-• **column**: ``null`` \| `number`
-
-#### Inherited from
-
-[InputStackFrame](InputStackFrame.md).[column](InputStackFrame.md#column)
-
-#### Defined in
-
-[plugins/symbolicate/types.ts:6](https://github.com/callstack/repack/blob/81f067f/packages/dev-server/src/plugins/symbolicate/types.ts#L6)
-
-___
-
-### file
-
-• **file**: `string`
-
-#### Inherited from
-
-[InputStackFrame](InputStackFrame.md).[file](InputStackFrame.md#file)
-
-#### Defined in
-
-[plugins/symbolicate/types.ts:15](https://github.com/callstack/repack/blob/81f067f/packages/dev-server/src/plugins/symbolicate/types.ts#L15)
-
-___
-
-### lineNumber
-
-• **lineNumber**: ``null`` \| `number`
-
-#### Inherited from
-
-[InputStackFrame](InputStackFrame.md).[lineNumber](InputStackFrame.md#linenumber)
-
-#### Defined in
-
-[plugins/symbolicate/types.ts:5](https://github.com/callstack/repack/blob/81f067f/packages/dev-server/src/plugins/symbolicate/types.ts#L5)
-
-___
-
-### methodName
-
-• **methodName**: `string`
-
-#### Inherited from
-
-[InputStackFrame](InputStackFrame.md).[methodName](InputStackFrame.md#methodname)
-
-#### Defined in
-
-[plugins/symbolicate/types.ts:8](https://github.com/callstack/repack/blob/81f067f/packages/dev-server/src/plugins/symbolicate/types.ts#L8)

package/docs/interfaces/SymbolicatorDelegate.md

@@ -1,77 +0,0 @@
-# Interface: SymbolicatorDelegate
-
-Delegate with implementation for symbolication functions.
-
-## Table of contents
-
-### Methods
-
-- [getSource](SymbolicatorDelegate.md#getsource)
-- [getSourceMap](SymbolicatorDelegate.md#getsourcemap)
-- [shouldIncludeFrame](SymbolicatorDelegate.md#shouldincludeframe)
-
-## Methods
-
-### getSource
-
-▸ **getSource**(`fileUrl`): `Promise`<`string` \| `Buffer`\>
-
-Get source code of file in the URL.
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `fileUrl` | `string` | A full URL pointing to a file. |
-
-#### Returns
-
-`Promise`<`string` \| `Buffer`\>
-
-#### Defined in
-
-[plugins/symbolicate/types.ts:54](https://github.com/callstack/repack/blob/81f067f/packages/dev-server/src/plugins/symbolicate/types.ts#L54)
-
-___
-
-### getSourceMap
-
-▸ **getSourceMap**(`fileUrl`): `Promise`<`string` \| `Buffer`\>
-
-Get source map for the file in the URL.
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `fileUrl` | `string` | A full (usually `http:`) URL pointing to a compiled file. The URL points to a file for which to return source map, not to the source map file itself, e.g: `http://localhost:8081/index.bundle?platform=ios`. |
-
-#### Returns
-
-`Promise`<`string` \| `Buffer`\>
-
-#### Defined in
-
-[plugins/symbolicate/types.ts:63](https://github.com/callstack/repack/blob/81f067f/packages/dev-server/src/plugins/symbolicate/types.ts#L63)
-
-___
-
-### shouldIncludeFrame
-
-▸ **shouldIncludeFrame**(`frame`): `boolean`
-
-Check if given stack frame should be included in the new symbolicated stack.
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `frame` | [`StackFrame`](StackFrame.md) | Stack frame to check. |
-
-#### Returns
-
-`boolean`
-
-#### Defined in
-
-[plugins/symbolicate/types.ts:70](https://github.com/callstack/repack/blob/81f067f/packages/dev-server/src/plugins/symbolicate/types.ts#L70)

package/docs/interfaces/SymbolicatorResults.md

@@ -1,30 +0,0 @@
-# Interface: SymbolicatorResults
-
-Represents results of running {@link process} method on {@link Symbolicator} instance.
-
-## Table of contents
-
-### Properties
-
-- [codeFrame](SymbolicatorResults.md#codeframe)
-- [stack](SymbolicatorResults.md#stack)
-
-## Properties
-
-### codeFrame
-
-• **codeFrame**: ``null`` \| [`CodeFrame`](CodeFrame.md)
-
-#### Defined in
-
-[plugins/symbolicate/types.ts:41](https://github.com/callstack/repack/blob/81f067f/packages/dev-server/src/plugins/symbolicate/types.ts#L41)
-
-___
-
-### stack
-
-• **stack**: [`StackFrame`](StackFrame.md)[]
-
-#### Defined in
-
-[plugins/symbolicate/types.ts:42](https://github.com/callstack/repack/blob/81f067f/packages/dev-server/src/plugins/symbolicate/types.ts#L42)

package/docs/modules/Internal.md

@@ -1,11 +0,0 @@
-# Namespace: Internal
-
-Internal types. Do not use.
-
-**`internal`**
-
-## Table of contents
-
-### Enumerations
-
-- [EventTypes](../enums/Internal.EventTypes.md)

package/docs/modules/Server.Api.md

@@ -1,11 +0,0 @@
-# Namespace: Api
-
-[Server](Server.md).Api
-
-## Table of contents
-
-### Interfaces
-
-- [Asset](../interfaces/Server.Api.Asset.md)
-- [CompilationStats](../interfaces/Server.Api.CompilationStats.md)
-- [Delegate](../interfaces/Server.Api.Delegate.md)

package/docs/modules/Server.md

@@ -1,16 +0,0 @@
-# Namespace: Server
-
-## Table of contents
-
-### Namespaces
-
-- [Api](Server.Api.md)
-
-### Interfaces
-
-- [Config](../interfaces/Server.Config.md)
-- [Delegate](../interfaces/Server.Delegate.md)
-- [DelegateContext](../interfaces/Server.DelegateContext.md)
-- [LoggerDelegate](../interfaces/Server.LoggerDelegate.md)
-- [MessagesDelegate](../interfaces/Server.MessagesDelegate.md)
-- [Options](../interfaces/Server.Options.md)

package/docs/types/SendProgress.md

@@ -1,26 +0,0 @@
-# Type alias: SendProgress
-
-Ƭ **SendProgress**: (`data`: [`ProgressData`](../interfaces/ProgressData.md)) => `void`
-
-#### Type declaration
-
-▸ (`data`): `void`
-
-Type representing a function to send the progress.
-
-Used by [CompilerDelegate](../interfaces/CompilerDelegate.md) in `getAsset` function to send the compilation
-progress to the client who requested the asset.
-
-##### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `data` | [`ProgressData`](../interfaces/ProgressData.md) |
-
-##### Returns
-
-`void`
-
-#### Defined in
-
-[types.ts:190](https://github.com/callstack/repack/blob/81f067f/packages/dev-server/src/types.ts#L190)