Types

@system-inc/base-foundation · 515c140 · 9 symbols

Local development-server settings for a worker project (BaseSettings.server): platform, host/port, request timeout, and — when protocol: 'https' — the certificate and key paths.

BaseServerSettings: InsecureServerSettings | SecureServerSettings

View source ↗

A database connection entry in the DATABASES environment variable: the database's configured name and its connection URL.

DatabaseEnvironmentVariables: unknown

Members

  • name: string

  • url: string

View source ↗

Runtime GraphQL configuration: the GraphQL settings with defaults applied (including the environment-aware graphiql/introspection toggles) plus the resolver classes the manifest aggregated.

GqlConfiguration: Required<Omit<GqlSettings, "graphiql" | "introspection">> & { graphiql: boolean; introspection: boolean; resolvers: (Constructor<object>)[] }

View source ↗

The feature toggles a { module, when } dependency can be scoped to. When the named feature is stripped from the declaring module (via BaseModuleOptions), the dependency is dropped.

ModuleFeatureToggle: "orm" | "eventBus" | "graphql" | "queue" | "router" | "rpc" | "scheduled" | "middleware" | "webSocket"

View source ↗

A type for defining the settings for a module.

ModuleSettings: BaseModuleSettings & ModuleSpecificSettings

View source ↗

A module dependency entry. Either a bare module key (always required) or a feature-scoped dependency that is only required when when is enabled on the declaring module — when is optional and omitting it means "always".

ModuleUse: BaseModuleKey<unknown> | { module: BaseModuleKey<unknown>; when?: ModuleFeatureToggle }

View source ↗

Runtime ORM configuration for one named database: the database's settings plus the entity lists the manifest aggregated (owned entities and queried-only externalEntities).

OrmConfiguration: OrmSettings<OrmAdapterType> & { databaseName: string; entities: OrmEntityClass[]; externalEntities: OrmEntityClass[] }

View source ↗

Runtime RPC server configuration: the RPC service settings with defaults applied plus the procedure classes the manifest aggregated.

RpcServerConfiguration: Required<RpcServiceSettings> & { procedures: (Constructor<object>)[] }

View source ↗

A function contributed by a module that validates the worker's deployment configuration against the module's runtime requirements.

Throw a WorkerConfigValidationError (or any Error) to signal a failure; the CLI will surface the message and exit.

WorkerConfigValidator: (context: WorkerConfigValidationContext) => void | Promise<void>

View source ↗