GlobalCacheServer

Import the server from its dedicated entry point:

import { GlobalCacheServer } from '@global-cache/core/server';

Constructor

new GlobalCacheServer()

Creates an independent server instance.

Returns: A new GlobalCacheServer instance.

server.start(config?: GlobalCacheServerConfig): Promise<void>

Starts the server.

Parameters

Name	Type	Description
`config`	`GlobalCacheServerConfig`	Optional server configuration (see below).

Property	Type	Description
`port`	`number`	Listening port. Uses an available port when omitted.
`basePath`	`string`	Persistent storage directory. Defaults to `.global-cache`.

server.stop(): Promise<void>

Stops a running server. Calling it when the server is already stopped is safe.

server.port: number

The resolved listening port, or 0 before the server starts.

server.localUrl: string

The server URL using localhost and the resolved port.

server.isRunning: boolean

Whether the server is accepting connections.