{ "version": "0.1.0-alpha.27", "revision": "96c331078104a0c9275238dbd0a714f5c48a53b6", "symbols": [ { "name": "MaligatorIntlFeature", "kind": "type", "signature": "export type MaligatorIntlFeature =\n\t| \"collator\"\n\t| \"number-format\"\n\t| \"date-time-format\"\n\t| \"plural-rules\"\n\t| \"list-format\"\n\t| \"segmenter\"\n\t| \"display-names\"\n\t| \"relative-time-format\"\n\t| \"duration-format\";", "module": "@maligator/cli", "url": "/api/build#MaligatorIntlFeature", "availability": "Build configuration; trusted project code.", "description": "Service selections used when Intl is enabled; an empty list includes every service.", "guides": [ "/guides/build-configuration", "/guides/assets" ] }, { "name": "AssetInclusion", "kind": "type", "signature": "export type AssetInclusion =\n\t| { type: \"file\"; path: string }\n\t| { type: \"directory\"; path: string; include: Array };", "module": "@maligator/cli", "url": "/api/build#AssetInclusion", "availability": "Build configuration; trusted project code.", "description": "Capture a regular file or a directory tree at build time. Paths are relative to\nthe project root. Directory patterns support *, ?, and whole-segment **;\nevery pattern must match a regular file. Symlinks are rejected.", "guides": [ "/guides/build-configuration", "/guides/assets" ] }, { "name": "MaligatorBuildConfig", "kind": "type", "signature": "export interface MaligatorBuildConfig {\n\t/** Project-root-relative entry; an explicit CLI entry takes precedence. */\n\tentry?: string;\n\t/** Binary name; otherwise inferred from the unscoped package name or project directory. */\n\toutputName?: string;\n\t/** Named build-time snapshots. Requires surface.maligator; portable serialized images cannot carry these filesystem resources. */\n\tassets?: Record;\n\tmodules?: {\n\t\t/** Exact specifier replacements applied before module resolution. Defaults to an empty map. */\n\t\taliases?: Record;\n\t};\n\tengine?: {\n\t\t/** Lock built-in objects for the entire build. Mutable is intended for compatibility experiments.\n\t\t * @default \"locked\"\n\t\t */\n\t\tprimordials?: \"locked\" | \"mutable\";\n\t\t/** Control dynamic compilation. false leaves eval/Function present but makes calls throw;\n\t\t * true embeds the compiler; compile-check also rejects statically visible calls at build time.\n\t\t * @default false\n\t\t * @see https://maligator.ddv.tools/api/build#engine.eval\n\t\t */\n\t\teval?: boolean | \"compile-check\";\n\t\t/** Include Realm support.\n\t\t * @default false\n\t\t */\n\t\trealms?: boolean;\n\t\t/** Include RegExp; disabling it trades compatibility for binary size.\n\t\t * @default true\n\t\t */\n\t\tregexp?: boolean;\n\t\t/** Include Temporal and its calendar/time-zone data.\n\t\t * @default false\n\t\t */\n\t\ttemporal?: boolean;\n\t\tintl?: {\n\t\t\t/** Include internationalization services and their native data.\n\t\t\t * @default false\n\t\t\t */\n\t\t\tenabled?: boolean;\n\t\t\t/** Select services. An empty list includes all services when enabled.\n\t\t\t * @default []\n\t\t\t */\n\t\t\tfeatures?: Array;\n\t\t\t/** Locale-data filtering is not implemented; only an empty list is accepted.\n\t\t\t * @default []\n\t\t\t */\n\t\t\tlanguages?: Array;\n\t\t};\n\t};\n\tsurface?: {\n\t\t/** Include Web APIs and Mal.serve. Declarations alone do not enable them.\n\t\t * @default false\n\t\t */\n\t\twebPlatform?: boolean;\n\t\t/** Include supported node: modules; see the compatibility table for coverage.\n\t\t * @default false\n\t\t */\n\t\tnode?: boolean;\n\t\t/** Include the mal namespace. Required for configured assets.\n\t\t * @default true\n\t\t */\n\t\tmaligator?: boolean;\n\t};\n}", "module": "@maligator/cli", "url": "/api/build#MaligatorBuildConfig", "availability": "Build configuration; trusted project code.", "description": "Trusted, strictly validated configuration evaluated for each CLI invocation.", "guides": [ "/guides/build-configuration", "/guides/assets" ] }, { "name": "entry", "kind": "member", "signature": "entry?: string;", "module": "@maligator/cli", "url": "/api/build#entry", "availability": "Build configuration; trusted project code.", "description": "Project-root-relative entry; an explicit CLI entry takes precedence.", "guides": [ "/guides/build-configuration", "/guides/assets" ] }, { "name": "outputName", "kind": "member", "signature": "outputName?: string;", "module": "@maligator/cli", "url": "/api/build#outputName", "availability": "Build configuration; trusted project code.", "description": "Binary name; otherwise inferred from the unscoped package name or project directory.", "guides": [ "/guides/build-configuration", "/guides/assets" ] }, { "name": "assets", "kind": "member", "signature": "assets?: Record;", "module": "@maligator/cli", "url": "/api/build#assets", "availability": "Build configuration; trusted project code.", "description": "Named build-time snapshots. Requires surface.maligator; portable serialized images cannot carry these filesystem resources.", "guides": [ "/guides/build-configuration", "/guides/assets" ] }, { "name": "modules", "kind": "member", "signature": "modules?: {\n\t\t/** Exact specifier replacements applied before module resolution. Defaults to an empty map. */\n\t\taliases?: Record;\n\t};", "module": "@maligator/cli", "url": "/api/build#modules", "availability": "Build configuration; trusted project code.", "description": "", "guides": [ "/guides/build-configuration", "/guides/assets" ] }, { "name": "modules.aliases", "kind": "member", "signature": "aliases?: Record;", "module": "@maligator/cli", "url": "/api/build#modules.aliases", "availability": "Build configuration; trusted project code.", "description": "Exact specifier replacements applied before module resolution. Defaults to an empty map.", "guides": [ "/guides/build-configuration", "/guides/assets" ] }, { "name": "engine", "kind": "member", "signature": "engine?: {\n\t\t/** Lock built-in objects for the entire build. Mutable is intended for compatibility experiments.\n\t\t * @default \"locked\"\n\t\t */\n\t\tprimordials?: \"locked\" | \"mutable\";\n\t\t/** Control dynamic compilation. false leaves eval/Function present but makes calls throw;\n\t\t * true embeds the compiler; compile-check also rejects statically visible calls at build time.\n\t\t * @default false\n\t\t * @see https://maligator.ddv.tools/api/build#engine.eval\n\t\t */\n\t\teval?: boolean | \"compile-check\";\n\t\t/** Include Realm support.\n\t\t * @default false\n\t\t */\n\t\trealms?: boolean;\n\t\t/** Include RegExp; disabling it trades compatibility for binary size.\n\t\t * @default true\n\t\t */\n\t\tregexp?: boolean;\n\t\t/** Include Temporal and its calendar/time-zone data.\n\t\t * @default false\n\t\t */\n\t\ttemporal?: boolean;\n\t\tintl?: {\n\t\t\t/** Include internationalization services and their native data.\n\t\t\t * @default false\n\t\t\t */\n\t\t\tenabled?: boolean;\n\t\t\t/** Select services. An empty list includes all services when enabled.\n\t\t\t * @default []\n\t\t\t */\n\t\t\tfeatures?: Array;\n\t\t\t/** Locale-data filtering is not implemented; only an empty list is accepted.\n\t\t\t * @default []\n\t\t\t */\n\t\t\tlanguages?: Array;\n\t\t};\n\t};", "module": "@maligator/cli", "url": "/api/build#engine", "availability": "Build configuration; trusted project code.", "description": "", "guides": [ "/guides/build-configuration", "/guides/assets" ] }, { "name": "engine.primordials", "kind": "member", "signature": "primordials?: \"locked\" | \"mutable\";", "module": "@maligator/cli", "url": "/api/build#engine.primordials", "availability": "Build configuration; trusted project code.", "description": "Lock built-in objects for the entire build. Mutable is intended for compatibility experiments.\nDefault: `\"locked\"`.", "default": "\"locked\"", "guides": [ "/guides/build-configuration", "/guides/assets" ] }, { "name": "engine.eval", "kind": "member", "signature": "eval?: boolean | \"compile-check\";", "module": "@maligator/cli", "url": "/api/build#engine.eval", "availability": "Build configuration; trusted project code.", "description": "Control dynamic compilation. false leaves eval/Function present but makes calls throw;\ntrue embeds the compiler; compile-check also rejects statically visible calls at build time.\nDefault: `false`.", "default": "false", "guides": [ "/guides/build-configuration", "/guides/assets" ] }, { "name": "engine.realms", "kind": "member", "signature": "realms?: boolean;", "module": "@maligator/cli", "url": "/api/build#engine.realms", "availability": "Build configuration; trusted project code.", "description": "Include Realm support.\nDefault: `false`.", "default": "false", "guides": [ "/guides/build-configuration", "/guides/assets" ] }, { "name": "engine.regexp", "kind": "member", "signature": "regexp?: boolean;", "module": "@maligator/cli", "url": "/api/build#engine.regexp", "availability": "Build configuration; trusted project code.", "description": "Include RegExp; disabling it trades compatibility for binary size.\nDefault: `true`.", "default": "true", "guides": [ "/guides/build-configuration", "/guides/assets" ] }, { "name": "engine.temporal", "kind": "member", "signature": "temporal?: boolean;", "module": "@maligator/cli", "url": "/api/build#engine.temporal", "availability": "Build configuration; trusted project code.", "description": "Include Temporal and its calendar/time-zone data.\nDefault: `false`.", "default": "false", "guides": [ "/guides/build-configuration", "/guides/assets" ] }, { "name": "engine.intl", "kind": "member", "signature": "intl?: {\n\t\t\t/** Include internationalization services and their native data.\n\t\t\t * @default false\n\t\t\t */\n\t\t\tenabled?: boolean;\n\t\t\t/** Select services. An empty list includes all services when enabled.\n\t\t\t * @default []\n\t\t\t */\n\t\t\tfeatures?: Array;\n\t\t\t/** Locale-data filtering is not implemented; only an empty list is accepted.\n\t\t\t * @default []\n\t\t\t */\n\t\t\tlanguages?: Array;\n\t\t};", "module": "@maligator/cli", "url": "/api/build#engine.intl", "availability": "Build configuration; trusted project code.", "description": "", "guides": [ "/guides/build-configuration", "/guides/assets" ] }, { "name": "engine.intl.enabled", "kind": "member", "signature": "enabled?: boolean;", "module": "@maligator/cli", "url": "/api/build#engine.intl.enabled", "availability": "Build configuration; trusted project code.", "description": "Include internationalization services and their native data.\nDefault: `false`.", "default": "false", "guides": [ "/guides/build-configuration", "/guides/assets" ] }, { "name": "engine.intl.features", "kind": "member", "signature": "features?: Array;", "module": "@maligator/cli", "url": "/api/build#engine.intl.features", "availability": "Build configuration; trusted project code.", "description": "Select services. An empty list includes all services when enabled.\nDefault: `[]`.", "default": "[]", "guides": [ "/guides/build-configuration", "/guides/assets" ] }, { "name": "engine.intl.languages", "kind": "member", "signature": "languages?: Array;", "module": "@maligator/cli", "url": "/api/build#engine.intl.languages", "availability": "Build configuration; trusted project code.", "description": "Locale-data filtering is not implemented; only an empty list is accepted.\nDefault: `[]`.", "default": "[]", "guides": [ "/guides/build-configuration", "/guides/assets" ] }, { "name": "surface", "kind": "member", "signature": "surface?: {\n\t\t/** Include Web APIs and Mal.serve. Declarations alone do not enable them.\n\t\t * @default false\n\t\t */\n\t\twebPlatform?: boolean;\n\t\t/** Include supported node: modules; see the compatibility table for coverage.\n\t\t * @default false\n\t\t */\n\t\tnode?: boolean;\n\t\t/** Include the mal namespace. Required for configured assets.\n\t\t * @default true\n\t\t */\n\t\tmaligator?: boolean;\n\t};", "module": "@maligator/cli", "url": "/api/build#surface", "availability": "Build configuration; trusted project code.", "description": "", "guides": [ "/guides/build-configuration", "/guides/assets" ] }, { "name": "surface.webPlatform", "kind": "member", "signature": "webPlatform?: boolean;", "module": "@maligator/cli", "url": "/api/build#surface.webPlatform", "availability": "Build configuration; trusted project code.", "description": "Include Web APIs and Mal.serve. Declarations alone do not enable them.\nDefault: `false`.", "default": "false", "guides": [ "/guides/build-configuration", "/guides/assets" ] }, { "name": "surface.node", "kind": "member", "signature": "node?: boolean;", "module": "@maligator/cli", "url": "/api/build#surface.node", "availability": "Build configuration; trusted project code.", "description": "Include supported node: modules; see the compatibility table for coverage.\nDefault: `false`.", "default": "false", "guides": [ "/guides/build-configuration", "/guides/assets" ] }, { "name": "surface.maligator", "kind": "member", "signature": "maligator?: boolean;", "module": "@maligator/cli", "url": "/api/build#surface.maligator", "availability": "Build configuration; trusted project code.", "description": "Include the mal namespace. Required for configured assets.\nDefault: `true`.", "default": "true", "guides": [ "/guides/build-configuration", "/guides/assets" ] }, { "name": "defineBuild", "kind": "export", "signature": "export declare function defineBuild(\n\tconfig: Config,\n): Config;", "module": "@maligator/cli", "url": "/api/build#defineBuild", "availability": "Build configuration; trusted project code.", "description": "Preserve the inferred config type. Validation happens when the CLI loads the config.\n\n```typescript\nimport { defineBuild } from \"@maligator/cli\";\nexport default defineBuild({ entry: \"src/index.ts\" });\n```", "guides": [ "/guides/build-configuration", "/guides/assets" ] }, { "name": "ready", "kind": "export", "signature": "export const ready: () => boolean;", "module": "maligator:application", "url": "/api/application#ready", "description": "Notify the development supervisor that this application is ready. Repeated calls are harmless. Returns true in a supervised application and false in a standalone application or ordinary worker. Call after resources such as a server listener are accepting work; this does not reserve ports or transfer traffic.", "availability": "experimental", "guides": [ "/guides/typescript", "/guides/development" ] }, { "name": "execution", "kind": "export", "signature": "export const execution: Execution;", "module": "maligator:process", "url": "/api/process#execution", "description": "An immutable snapshot of the workflow, target, and resolved configuration, fixed before compilation. Known property reads can specialize application branches. Runtime arguments, environment, working directory, and PID are outside this snapshot. Profiling does not change production intent. Static and dynamic imports share its identity, and reflection sees the complete deeply frozen shape.", "availability": "experimental", "guides": [ "/guides/typescript", "/guides/production" ] }, { "name": "ExecutionProfile", "kind": "type", "signature": "type ExecutionProfile = \"none\" | \"sampling\" | \"compiler\";", "module": "maligator:process", "url": "/api/process#ExecutionProfile", "description": "Profiling instrumentation: none by default; sampling for --profile; compiler for --profile=compiler. Both profiling modes select full optimization without selecting production application behavior.", "availability": "experimental", "guides": [ "/guides/typescript", "/guides/production" ] }, { "name": "ExecutionTarget", "kind": "type", "signature": "type ExecutionTarget = {\n\t/**\n\t * Application operating-system target, not the compiler host. Native builds use\n\t * darwin or linux; WebAssembly uses wasi.\n\t */\n\treadonly platform: \"darwin\" | \"linux\" | \"wasi\";\n\t/**\n\t * Application architecture. Cross builds report the destination architecture.\n\t */\n\treadonly arch: \"arm64\" | \"x64\" | \"wasm32\";\n\t/**\n\t * Resolved target triple, including when --target was omitted; for example\n\t * aarch64-apple-darwin.\n\t */\n\treadonly triple: string;\n};", "module": "maligator:process", "url": "/api/process#ExecutionTarget", "description": "The fixed platform contract of the application image.", "availability": "experimental", "guides": [ "/guides/typescript", "/guides/production" ] }, { "name": "ExecutionTarget.platform", "kind": "member", "signature": "readonly platform: \"darwin\" | \"linux\" | \"wasi\";", "module": "maligator:process", "url": "/api/process#ExecutionTarget.platform", "availability": "Experimental; no surface flag required.", "description": "Application operating-system target, not the compiler host. Native builds use\ndarwin or linux; WebAssembly uses wasi.", "guides": [ "/guides/typescript", "/guides/production" ] }, { "name": "ExecutionTarget.arch", "kind": "member", "signature": "readonly arch: \"arm64\" | \"x64\" | \"wasm32\";", "module": "maligator:process", "url": "/api/process#ExecutionTarget.arch", "availability": "Experimental; no surface flag required.", "description": "Application architecture. Cross builds report the destination architecture.", "guides": [ "/guides/typescript", "/guides/production" ] }, { "name": "ExecutionTarget.triple", "kind": "member", "signature": "readonly triple: string;", "module": "maligator:process", "url": "/api/process#ExecutionTarget.triple", "availability": "Experimental; no surface flag required.", "description": "Resolved target triple, including when --target was omitted; for example\naarch64-apple-darwin.", "guides": [ "/guides/typescript", "/guides/production" ] }, { "name": "ExecutionOptions", "kind": "type", "signature": "type ExecutionOptions = {\n\t/**\n\t * Selected application profiling instrumentation. Defaults to none; does not imply\n\t * execution.production.\n\t */\n\treadonly profile: ExecutionProfile;\n};", "module": "maligator:process", "url": "/api/process#ExecutionOptions", "description": "Options shared by build, run, and dev. Output paths, verbosity, and compiler scheduling are tool settings and are not exposed.", "availability": "experimental", "guides": [ "/guides/typescript", "/guides/production" ] }, { "name": "ExecutionOptions.profile", "kind": "member", "signature": "readonly profile: ExecutionProfile;", "module": "maligator:process", "url": "/api/process#ExecutionOptions.profile", "availability": "Experimental; no surface flag required.", "description": "Selected application profiling instrumentation. Defaults to none; does not imply\nexecution.production.", "guides": [ "/guides/typescript", "/guides/production" ] }, { "name": "TestExecutionOptions", "kind": "type", "signature": "type TestExecutionOptions = {\n\t/**\n\t * Selected test profiling instrumentation. Defaults to none; profiling preserves\n\t * command: test.\n\t */\n\treadonly profile: ExecutionProfile;\n\t/**\n\t * Hierarchical test-name filter from --run, or null when all discovered names are\n\t * eligible.\n\t */\n\treadonly nameFilter: string | null;\n\t/**\n\t * Number of requested test repetitions from --repeat; defaults to 1. This is not the\n\t * currently executing repetition.\n\t */\n\treadonly repeat: number;\n\t/**\n\t * Whether --bail stops the test run after its first failure. Defaults to false.\n\t */\n\treadonly bail: boolean;\n\t/**\n\t * Test callback timeout in milliseconds from --timeout. Defaults to 5000.\n\t */\n\treadonly timeoutMs: number;\n\t/**\n\t * Resolved positive shuffle seed, or null when shuffling is disabled. --shuffle\n\t * without a seed chooses it once before compilation; the same seed drives execution\n\t * and cache identity.\n\t */\n\treadonly shuffleSeed: number | null;\n};", "module": "maligator:process", "url": "/api/process#TestExecutionOptions", "description": "Normalized test settings, fixed for the application image. Changing these values invalidates specialized test artifacts.", "availability": "experimental", "guides": [ "/guides/typescript", "/guides/production" ] }, { "name": "TestExecutionOptions.profile", "kind": "member", "signature": "readonly profile: ExecutionProfile;", "module": "maligator:process", "url": "/api/process#TestExecutionOptions.profile", "availability": "Experimental; no surface flag required.", "description": "Selected test profiling instrumentation. Defaults to none; profiling preserves\ncommand: test.", "guides": [ "/guides/typescript", "/guides/production" ] }, { "name": "TestExecutionOptions.nameFilter", "kind": "member", "signature": "readonly nameFilter: string | null;", "module": "maligator:process", "url": "/api/process#TestExecutionOptions.nameFilter", "availability": "Experimental; no surface flag required.", "description": "Hierarchical test-name filter from --run, or null when all discovered names are\neligible.", "guides": [ "/guides/typescript", "/guides/production" ] }, { "name": "TestExecutionOptions.repeat", "kind": "member", "signature": "readonly repeat: number;", "module": "maligator:process", "url": "/api/process#TestExecutionOptions.repeat", "availability": "Experimental; no surface flag required.", "description": "Number of requested test repetitions from --repeat; defaults to 1. This is not the\ncurrently executing repetition.", "guides": [ "/guides/typescript", "/guides/production" ] }, { "name": "TestExecutionOptions.bail", "kind": "member", "signature": "readonly bail: boolean;", "module": "maligator:process", "url": "/api/process#TestExecutionOptions.bail", "availability": "Experimental; no surface flag required.", "description": "Whether --bail stops the test run after its first failure. Defaults to false.", "guides": [ "/guides/typescript", "/guides/production" ] }, { "name": "TestExecutionOptions.timeoutMs", "kind": "member", "signature": "readonly timeoutMs: number;", "module": "maligator:process", "url": "/api/process#TestExecutionOptions.timeoutMs", "availability": "Experimental; no surface flag required.", "description": "Test callback timeout in milliseconds from --timeout. Defaults to 5000.", "guides": [ "/guides/typescript", "/guides/production" ] }, { "name": "TestExecutionOptions.shuffleSeed", "kind": "member", "signature": "readonly shuffleSeed: number | null;", "module": "maligator:process", "url": "/api/process#TestExecutionOptions.shuffleSeed", "availability": "Experimental; no surface flag required.", "description": "Resolved positive shuffle seed, or null when shuffling is disabled. --shuffle\nwithout a seed chooses it once before compilation; the same seed drives execution\nand cache identity.", "guides": [ "/guides/typescript", "/guides/production" ] }, { "name": "ExecutionEngineConfig", "kind": "type", "signature": "type ExecutionEngineConfig = {\n\t/**\n\t * Requested primordial mutation policy. Defaults to locked. The execution snapshot\n\t * itself is immutable in either policy.\n\t */\n\treadonly primordials: \"locked\" | \"mutable\";\n\t/**\n\t * Dynamic compilation policy. false (default) rejects eval/Function execution at\n\t * runtime; true enables the runtime compiler; compile-check additionally rejects\n\t * statically visible dynamic compilation calls.\n\t */\n\treadonly eval: boolean | \"compile-check\";\n\t/**\n\t * Whether additional realms are enabled. Defaults to false.\n\t */\n\treadonly realms: boolean;\n\t/**\n\t * Whether regular expressions are enabled. Defaults to true.\n\t */\n\treadonly regexp: boolean;\n\t/**\n\t * Whether Temporal and its required data are enabled. Defaults to false.\n\t */\n\treadonly temporal: boolean;\n\t/**\n\t * Requested Intl policy after applying configuration defaults.\n\t */\n\treadonly intl: {\n\t\t/**\n\t\t * Whether Intl is enabled. Defaults to false.\n\t\t */\n\t\treadonly enabled: boolean;\n\t\t/**\n\t\t * Requested Intl service names. An empty array selects the default complete service\n\t\t * set when Intl is enabled; it does not mean every service survived tree shaking.\n\t\t */\n\t\treadonly features: ReadonlyArray;\n\t\t/**\n\t\t * Requested locale selection. Defaults to an empty array. Unsupported locale\n\t\t * selections are rejected by configuration validation.\n\t\t */\n\t\treadonly languages: ReadonlyArray;\n\t};\n};", "module": "maligator:process", "url": "/api/process#ExecutionEngineConfig", "description": "Resolved engine policies. These describe build inputs, never post-DCE native feature inclusion.", "availability": "experimental", "guides": [ "/guides/typescript", "/guides/production" ] }, { "name": "ExecutionEngineConfig.primordials", "kind": "member", "signature": "readonly primordials: \"locked\" | \"mutable\";", "module": "maligator:process", "url": "/api/process#ExecutionEngineConfig.primordials", "availability": "Experimental; no surface flag required.", "description": "Requested primordial mutation policy. Defaults to locked. The execution snapshot\nitself is immutable in either policy.", "guides": [ "/guides/typescript", "/guides/production" ] }, { "name": "ExecutionEngineConfig.eval", "kind": "member", "signature": "readonly eval: boolean | \"compile-check\";", "module": "maligator:process", "url": "/api/process#ExecutionEngineConfig.eval", "availability": "Experimental; no surface flag required.", "description": "Dynamic compilation policy. false (default) rejects eval/Function execution at\nruntime; true enables the runtime compiler; compile-check additionally rejects\nstatically visible dynamic compilation calls.", "guides": [ "/guides/typescript", "/guides/production" ] }, { "name": "ExecutionEngineConfig.realms", "kind": "member", "signature": "readonly realms: boolean;", "module": "maligator:process", "url": "/api/process#ExecutionEngineConfig.realms", "availability": "Experimental; no surface flag required.", "description": "Whether additional realms are enabled. Defaults to false.", "guides": [ "/guides/typescript", "/guides/production" ] }, { "name": "ExecutionEngineConfig.regexp", "kind": "member", "signature": "readonly regexp: boolean;", "module": "maligator:process", "url": "/api/process#ExecutionEngineConfig.regexp", "availability": "Experimental; no surface flag required.", "description": "Whether regular expressions are enabled. Defaults to true.", "guides": [ "/guides/typescript", "/guides/production" ] }, { "name": "ExecutionEngineConfig.temporal", "kind": "member", "signature": "readonly temporal: boolean;", "module": "maligator:process", "url": "/api/process#ExecutionEngineConfig.temporal", "availability": "Experimental; no surface flag required.", "description": "Whether Temporal and its required data are enabled. Defaults to false.", "guides": [ "/guides/typescript", "/guides/production" ] }, { "name": "ExecutionEngineConfig.intl", "kind": "member", "signature": "readonly intl: {\n\t\t/**\n\t\t * Whether Intl is enabled. Defaults to false.\n\t\t */\n\t\treadonly enabled: boolean;\n\t\t/**\n\t\t * Requested Intl service names. An empty array selects the default complete service\n\t\t * set when Intl is enabled; it does not mean every service survived tree shaking.\n\t\t */\n\t\treadonly features: ReadonlyArray;\n\t\t/**\n\t\t * Requested locale selection. Defaults to an empty array. Unsupported locale\n\t\t * selections are rejected by configuration validation.\n\t\t */\n\t\treadonly languages: ReadonlyArray;\n\t};", "module": "maligator:process", "url": "/api/process#ExecutionEngineConfig.intl", "availability": "Experimental; no surface flag required.", "description": "Requested Intl policy after applying configuration defaults.", "guides": [ "/guides/typescript", "/guides/production" ] }, { "name": "ExecutionEngineConfig.intl.enabled", "kind": "member", "signature": "readonly enabled: boolean;", "module": "maligator:process", "url": "/api/process#ExecutionEngineConfig.intl.enabled", "availability": "Experimental; no surface flag required.", "description": "Whether Intl is enabled. Defaults to false.", "guides": [ "/guides/typescript", "/guides/production" ] }, { "name": "ExecutionEngineConfig.intl.features", "kind": "member", "signature": "readonly features: ReadonlyArray;", "module": "maligator:process", "url": "/api/process#ExecutionEngineConfig.intl.features", "availability": "Experimental; no surface flag required.", "description": "Requested Intl service names. An empty array selects the default complete service\nset when Intl is enabled; it does not mean every service survived tree shaking.", "guides": [ "/guides/typescript", "/guides/production" ] }, { "name": "ExecutionEngineConfig.intl.languages", "kind": "member", "signature": "readonly languages: ReadonlyArray;", "module": "maligator:process", "url": "/api/process#ExecutionEngineConfig.intl.languages", "availability": "Experimental; no surface flag required.", "description": "Requested locale selection. Defaults to an empty array. Unsupported locale\nselections are rejected by configuration validation.", "guides": [ "/guides/typescript", "/guides/production" ] }, { "name": "ExecutionConfig", "kind": "type", "signature": "type ExecutionConfig = {\n\t/**\n\t * Engine configuration after validation and default resolution.\n\t */\n\treadonly engine: ExecutionEngineConfig;\n\t/**\n\t * Global and compatibility surface policy. maligator:process requires no enable\n\t * flag.\n\t */\n\treadonly surface: {\n\t\t/**\n\t\t * Whether Web globals are requested. Defaults to false; native module imports are\n\t\t * independent of this global installation policy.\n\t\t */\n\t\treadonly webPlatform: boolean;\n\t\t/**\n\t\t * Whether Node compatibility, globals, and node: module resolution are requested.\n\t\t * Defaults to false.\n\t\t */\n\t\treadonly node: boolean;\n\t};\n\t/**\n\t * Resolved module-resolution policy.\n\t */\n\treadonly modules: {\n\t\t/**\n\t\t * Exact module-specifier replacements from configuration. Defaults to an empty\n\t\t * object. Alias entries are immutable own data properties.\n\t\t */\n\t\treadonly aliases: Readonly>;\n\t};\n};", "module": "maligator:process", "url": "/api/process#ExecutionConfig", "description": "Resolved application engine, Web/Node surface, and module policies. Excludes build-host paths, asset declarations, and output controls.", "availability": "experimental", "guides": [ "/guides/typescript", "/guides/production" ] }, { "name": "ExecutionConfig.engine", "kind": "member", "signature": "readonly engine: ExecutionEngineConfig;", "module": "maligator:process", "url": "/api/process#ExecutionConfig.engine", "availability": "Experimental; no surface flag required.", "description": "Engine configuration after validation and default resolution.", "guides": [ "/guides/typescript", "/guides/production" ] }, { "name": "ExecutionConfig.surface", "kind": "member", "signature": "readonly surface: {\n\t\t/**\n\t\t * Whether Web globals are requested. Defaults to false; native module imports are\n\t\t * independent of this global installation policy.\n\t\t */\n\t\treadonly webPlatform: boolean;\n\t\t/**\n\t\t * Whether Node compatibility, globals, and node: module resolution are requested.\n\t\t * Defaults to false.\n\t\t */\n\t\treadonly node: boolean;\n\t};", "module": "maligator:process", "url": "/api/process#ExecutionConfig.surface", "availability": "Experimental; no surface flag required.", "description": "Global and compatibility surface policy. maligator:process requires no enable\nflag.", "guides": [ "/guides/typescript", "/guides/production" ] }, { "name": "ExecutionConfig.surface.webPlatform", "kind": "member", "signature": "readonly webPlatform: boolean;", "module": "maligator:process", "url": "/api/process#ExecutionConfig.surface.webPlatform", "availability": "Experimental; no surface flag required.", "description": "Whether Web globals are requested. Defaults to false; native module imports are\nindependent of this global installation policy.", "guides": [ "/guides/typescript", "/guides/production" ] }, { "name": "ExecutionConfig.surface.node", "kind": "member", "signature": "readonly node: boolean;", "module": "maligator:process", "url": "/api/process#ExecutionConfig.surface.node", "availability": "Experimental; no surface flag required.", "description": "Whether Node compatibility, globals, and node: module resolution are requested.\nDefaults to false.", "guides": [ "/guides/typescript", "/guides/production" ] }, { "name": "ExecutionConfig.modules", "kind": "member", "signature": "readonly modules: {\n\t\t/**\n\t\t * Exact module-specifier replacements from configuration. Defaults to an empty\n\t\t * object. Alias entries are immutable own data properties.\n\t\t */\n\t\treadonly aliases: Readonly>;\n\t};", "module": "maligator:process", "url": "/api/process#ExecutionConfig.modules", "availability": "Experimental; no surface flag required.", "description": "Resolved module-resolution policy.", "guides": [ "/guides/typescript", "/guides/production" ] }, { "name": "ExecutionConfig.modules.aliases", "kind": "member", "signature": "readonly aliases: Readonly>;", "module": "maligator:process", "url": "/api/process#ExecutionConfig.modules.aliases", "availability": "Experimental; no surface flag required.", "description": "Exact module-specifier replacements from configuration. Defaults to an empty\nobject. Alias entries are immutable own data properties.", "guides": [ "/guides/typescript", "/guides/production" ] }, { "name": "ExecutionCommon", "kind": "type", "signature": "type ExecutionCommon = {\n\t/**\n\t * Explicit production application intent. True only when production was selected for\n\t * the application; independent of NODE_ENV, profiling, and optimization. Currently\n\t * --production is a build option. Defaults to false.\n\t */\n\treadonly production: boolean;\n\t/**\n\t * Whether the application image executes as native compiled code. A native\n\t * executable hosting an interpreted image reports false. This is fixed for the\n\t * image, not a query about the current stack frame or an eval-created function.\n\t */\n\treadonly compiled: boolean;\n\t/**\n\t * Actual selected frontend optimization policy. Ordinary commands currently use\n\t * development; production builds and profiling use full. Backend choice is\n\t * independent.\n\t */\n\treadonly optimization: \"development\" | \"full\";\n\t/**\n\t * Resolved application target. The compiler's host platform is not substituted\n\t * during a cross build.\n\t */\n\treadonly target: ExecutionTarget;\n\t/**\n\t * Validated configuration policies with defaults applied, captured before\n\t * compilation.\n\t */\n\treadonly config: ExecutionConfig;\n};", "module": "maligator:process", "url": "/api/process#ExecutionCommon", "description": "Fields shared by every execution workflow. All nested objects and arrays are deeply frozen at runtime.", "availability": "experimental", "guides": [ "/guides/typescript", "/guides/production" ] }, { "name": "ExecutionCommon.production", "kind": "member", "signature": "readonly production: boolean;", "module": "maligator:process", "url": "/api/process#ExecutionCommon.production", "availability": "Experimental; no surface flag required.", "description": "Explicit production application intent. True only when production was selected for\nthe application; independent of NODE_ENV, profiling, and optimization. Currently\n--production is a build option. Defaults to false.", "guides": [ "/guides/typescript", "/guides/production" ] }, { "name": "ExecutionCommon.compiled", "kind": "member", "signature": "readonly compiled: boolean;", "module": "maligator:process", "url": "/api/process#ExecutionCommon.compiled", "availability": "Experimental; no surface flag required.", "description": "Whether the application image executes as native compiled code. A native\nexecutable hosting an interpreted image reports false. This is fixed for the\nimage, not a query about the current stack frame or an eval-created function.", "guides": [ "/guides/typescript", "/guides/production" ] }, { "name": "ExecutionCommon.optimization", "kind": "member", "signature": "readonly optimization: \"development\" | \"full\";", "module": "maligator:process", "url": "/api/process#ExecutionCommon.optimization", "availability": "Experimental; no surface flag required.", "description": "Actual selected frontend optimization policy. Ordinary commands currently use\ndevelopment; production builds and profiling use full. Backend choice is\nindependent.", "guides": [ "/guides/typescript", "/guides/production" ] }, { "name": "ExecutionCommon.target", "kind": "member", "signature": "readonly target: ExecutionTarget;", "module": "maligator:process", "url": "/api/process#ExecutionCommon.target", "availability": "Experimental; no surface flag required.", "description": "Resolved application target. The compiler's host platform is not substituted\nduring a cross build.", "guides": [ "/guides/typescript", "/guides/production" ] }, { "name": "ExecutionCommon.config", "kind": "member", "signature": "readonly config: ExecutionConfig;", "module": "maligator:process", "url": "/api/process#ExecutionCommon.config", "availability": "Experimental; no surface flag required.", "description": "Validated configuration policies with defaults applied, captured before\ncompilation.", "guides": [ "/guides/typescript", "/guides/production" ] }, { "name": "Execution", "kind": "type", "signature": "type Execution = ExecutionCommon & ({\n\t/**\n\t * Prepared by maligator build. Remains build when the resulting executable runs\n\t * later; application statements are not executed by the build itself.\n\t */\n\treadonly command: \"build\";\n\t/**\n\t * Normalized build options relevant to application execution.\n\t */\n\treadonly options: ExecutionOptions;\n} | {\n\t/**\n\t * Prepared by maligator run or maligator dev. dev denotes the watch/restart workflow\n\t * even when profiling selects native compilation.\n\t */\n\treadonly command: \"run\" | \"dev\";\n\t/**\n\t * Normalized run/dev options. Arguments after -- remain runtime argv and do not\n\t * specialize application compilation.\n\t */\n\treadonly options: ExecutionOptions;\n} | {\n\t/**\n\t * Prepared by maligator test. Preserved for interpreted tests, profiled native\n\t * tests, and every fragment of the test application.\n\t */\n\treadonly command: \"test\";\n\t/**\n\t * Normalized test options. Narrow command to test before accessing test-only fields.\n\t */\n\treadonly options: TestExecutionOptions;\n});", "module": "maligator:process", "url": "/api/process#Execution", "description": "An immutable application-image description, discriminated by command. The command describes the workflow that prepared the image, not a transient process phase.", "availability": "experimental", "guides": [ "/guides/typescript", "/guides/production" ] }, { "name": "createPool", "kind": "export", "signature": "export const createPool: (entry: WorkerUrl, options?: PoolOptions) => WorkerPool;", "module": "maligator:workers", "url": "/api/workers#createPool", "description": "Create a bounded pool of persistent workers for a declared entry. Submission failures throw synchronously; admitted tasks settle asynchronously. Await ready before submitting startup-dependent work and close the pool when finished. Throws NotSupportedError without threads and RangeError for invalid bounds.", "availability": "experimental", "guides": [ "/guides/typescript", "/guides/workers", "/guides/workers/messages", "/guides/workers/cancellation" ] }, { "name": "createWorkerUrl", "kind": "export", "signature": "export const createWorkerUrl: (specifier: string, base: string) => WorkerUrl;", "module": "maligator:workers", "url": "/api/workers#createWorkerUrl", "description": "Declare an entry using a static string literal and explicit import.meta.url base. The immutable href projection can be passed to existing worker libraries.", "availability": "experimental", "guides": [ "/guides/typescript", "/guides/workers", "/guides/workers/messages", "/guides/workers/cancellation" ] }, { "name": "transfer", "kind": "export", "signature": "export const transfer: (value: Value, transfer: ReadonlyArray) => TransferResult;", "module": "maligator:workers", "url": "/api/workers#transfer", "description": "Wrap a result for transfer when the worker publishes it.", "availability": "experimental", "guides": [ "/guides/typescript", "/guides/workers", "/guides/workers/messages", "/guides/workers/cancellation" ] }, { "name": "Worker", "kind": "export", "signature": "export const Worker: { new(entry: WorkerUrl, options?: WorkerOptions): Worker };", "module": "maligator:workers", "url": "/api/workers#Worker", "description": "Start a declared isolated module and expose its ordered port and complete lifecycle.", "availability": "experimental", "guides": [ "/guides/typescript", "/guides/workers", "/guides/workers/messages", "/guides/workers/cancellation" ] }, { "name": "MessageChannel", "kind": "export", "signature": "export const MessageChannel: { new(options?: MessageChannelOptions): MessageChannel };", "module": "maligator:workers", "url": "/api/workers#MessageChannel", "description": "Create two transferable endpoints independently of worker startup.", "availability": "experimental", "guides": [ "/guides/typescript", "/guides/workers", "/guides/workers/messages", "/guides/workers/cancellation" ] }, { "name": "MessagePort", "kind": "export", "signature": "export const MessagePort: { readonly prototype: MessagePort };", "module": "maligator:workers", "url": "/api/workers#MessagePort", "description": "The port prototype for type and identity checks. Ports are created by channels and workers.", "availability": "experimental", "guides": [ "/guides/typescript", "/guides/workers", "/guides/workers/messages", "/guides/workers/cancellation" ] }, { "name": "receiveMessageOnPort", "kind": "export", "signature": "export const receiveMessageOnPort: (port: MessagePort) => { message: Receive } | undefined;", "module": "maligator:workers", "url": "/api/workers#receiveMessageOnPort", "description": "Synchronously dequeue one pending message without running unrelated callbacks.", "availability": "experimental", "guides": [ "/guides/typescript", "/guides/workers", "/guides/workers/messages", "/guides/workers/cancellation" ] }, { "name": "capabilities", "kind": "export", "signature": "export const capabilities: () => { readonly threads: boolean; readonly sharedMemory: boolean; readonly parallelism: number; readonly maxWorkers: number };", "module": "maligator:workers", "url": "/api/workers#capabilities", "description": "Report the running host's worker facilities and capacity.", "availability": "experimental", "guides": [ "/guides/typescript", "/guides/workers", "/guides/workers/messages", "/guides/workers/cancellation" ] }, { "name": "parentPort", "kind": "export", "signature": "export const parentPort: MessagePort | null;", "module": "maligator:workers", "url": "/api/workers#parentPort", "description": "The worker's parent endpoint; null in the main isolate.", "availability": "experimental", "guides": [ "/guides/typescript", "/guides/workers", "/guides/workers/messages", "/guides/workers/cancellation" ] }, { "name": "workerData", "kind": "export", "signature": "export const workerData: unknown;", "module": "maligator:workers", "url": "/api/workers#workerData", "description": "The worker-owned clone of startup data.", "availability": "experimental", "guides": [ "/guides/typescript", "/guides/workers", "/guides/workers/messages", "/guides/workers/cancellation" ] }, { "name": "WorkerUrl", "kind": "type", "signature": "type WorkerUrl = { readonly href: string; readonly __workerModule?: Module };", "module": "maligator:workers", "url": "/api/workers#WorkerUrl", "description": "An immutable image-local worker entry declaration. The compiler resolves the declaration independently of how libraries pass the descriptor or its href onward. Erased module types express the caller's assertion; runtime entry identity is validated.", "availability": "experimental", "guides": [ "/guides/typescript", "/guides/workers", "/guides/workers/messages", "/guides/workers/cancellation" ] }, { "name": "WorkerUrl.href", "kind": "member", "signature": "readonly href: string;", "module": "maligator:workers", "url": "/api/workers#WorkerUrl.href", "availability": "Experimental; no surface flag required.", "description": "", "guides": [ "/guides/typescript", "/guides/workers", "/guides/workers/messages", "/guides/workers/cancellation" ] }, { "name": "WorkerUrl.__workerModule", "kind": "member", "signature": "readonly __workerModule?: Module", "module": "maligator:workers", "url": "/api/workers#WorkerUrl.__workerModule", "availability": "Experimental; no surface flag required.", "description": "", "guides": [ "/guides/typescript", "/guides/workers", "/guides/workers/messages", "/guides/workers/cancellation" ] }, { "name": "Transferable", "kind": "type", "signature": "type Transferable = ArrayBuffer | MessagePort;", "module": "maligator:workers", "url": "/api/workers#Transferable", "description": "ArrayBuffer stores move at admission. MessagePort endpoints transfer ownership. SharedArrayBuffer is cloned by sharing its backing and cannot be transferred.", "availability": "experimental", "guides": [ "/guides/typescript", "/guides/workers", "/guides/workers/messages", "/guides/workers/cancellation" ] }, { "name": "TaskContext", "kind": "type", "signature": "type TaskContext = {\n /** Worker-local cancellation signal. Cancellation does not preempt JavaScript. */\n readonly signal: AbortSignal;\n /** Throws if cancelled. Check between bounded pieces of work. */\n throwIfCancelled(): void;\n};", "module": "maligator:workers", "url": "/api/workers#TaskContext", "description": "Cancellation is cooperative while a pool task runs. The worker remains occupied until the task's returned promise settles.", "availability": "experimental", "guides": [ "/guides/typescript", "/guides/workers", "/guides/workers/messages", "/guides/workers/cancellation" ] }, { "name": "TaskContext.signal", "kind": "member", "signature": "readonly signal: AbortSignal;", "module": "maligator:workers", "url": "/api/workers#TaskContext.signal", "availability": "Experimental; no surface flag required.", "description": "Worker-local cancellation signal. Cancellation does not preempt JavaScript.", "guides": [ "/guides/typescript", "/guides/workers", "/guides/workers/messages", "/guides/workers/cancellation" ] }, { "name": "TaskContext.throwIfCancelled", "kind": "member", "signature": "throwIfCancelled(): void;", "module": "maligator:workers", "url": "/api/workers#TaskContext.throwIfCancelled", "availability": "Experimental; no surface flag required.", "description": "Throws if cancelled. Check between bounded pieces of work.", "guides": [ "/guides/typescript", "/guides/workers", "/guides/workers/messages", "/guides/workers/cancellation" ] }, { "name": "TransferResult", "kind": "type", "signature": "type TransferResult = { readonly value: Value; readonly __transferResult: unique symbol };", "module": "maligator:workers", "url": "/api/workers#TransferResult", "description": "An opaque result envelope. Constructing it does not detach buffers; publication commits transfers.", "availability": "experimental", "guides": [ "/guides/typescript", "/guides/workers", "/guides/workers/messages", "/guides/workers/cancellation" ] }, { "name": "TransferResult.value", "kind": "member", "signature": "readonly value: Value;", "module": "maligator:workers", "url": "/api/workers#TransferResult.value", "availability": "Experimental; no surface flag required.", "description": "", "guides": [ "/guides/typescript", "/guides/workers", "/guides/workers/messages", "/guides/workers/cancellation" ] }, { "name": "TransferResult.__transferResult", "kind": "member", "signature": "readonly __transferResult: unique symbol", "module": "maligator:workers", "url": "/api/workers#TransferResult.__transferResult", "availability": "Experimental; no surface flag required.", "description": "", "guides": [ "/guides/typescript", "/guides/workers", "/guides/workers/messages", "/guides/workers/cancellation" ] }, { "name": "TaskNames", "kind": "type", "signature": "type TaskNames = { [Key in keyof Module]-?: Module[Key] extends (context: TaskContext, ...args: infer Args) => unknown ? Key : never }[keyof Module] & string;", "module": "maligator:workers", "url": "/api/workers#TaskNames", "description": "Names of context-first exported task functions.", "availability": "experimental", "guides": [ "/guides/typescript", "/guides/workers", "/guides/workers/messages", "/guides/workers/cancellation" ] }, { "name": "TaskArgs", "kind": "type", "signature": "type TaskArgs = Function extends (context: TaskContext, ...args: infer Args) => unknown ? Args : never;", "module": "maligator:workers", "url": "/api/workers#TaskArgs", "description": "The task's argument tuple, excluding its local cancellation context.", "availability": "experimental", "guides": [ "/guides/typescript", "/guides/workers", "/guides/workers/messages", "/guides/workers/cancellation" ] }, { "name": "TaskValue", "kind": "type", "signature": "type TaskValue = Function extends (...args: Array) => infer Result ? Awaited extends TransferResult ? Value : Awaited : never;", "module": "maligator:workers", "url": "/api/workers#TaskValue", "description": "The settled task result after unwrapping an explicit transfer envelope.", "availability": "experimental", "guides": [ "/guides/typescript", "/guides/workers", "/guides/workers/messages", "/guides/workers/cancellation" ] }, { "name": "PoolOptions", "kind": "type", "signature": "type PoolOptions = {\n /** Positive safe integer; defaults to host parallelism, falling back to 1. */\n size?: number;\n /** Nonnegative safe integer; defaults to four times size. Zero disables the waiting queue. */\n maxQueuedTasks?: number;\n /** Positive safe integer in bytes; defaults to 67108864 (64 MiB). */\n maxQueuedBytes?: number;\n /** Positive safe integer in bytes; defaults to maxQueuedBytes. */\n maxMessageBytes?: number;\n /** Worker name prefix; each worker receives a one-based suffix. */\n name?: string;\n};", "module": "maligator:workers", "url": "/api/workers#PoolOptions", "description": "Fixed persistent worker count and admission bounds. Every worker has independent module state. A size-one pool dispatches admitted tasks serially.", "availability": "experimental", "guides": [ "/guides/typescript", "/guides/workers", "/guides/workers/messages", "/guides/workers/cancellation" ] }, { "name": "PoolOptions.size", "kind": "member", "signature": "size?: number;", "module": "maligator:workers", "url": "/api/workers#PoolOptions.size", "availability": "Experimental; no surface flag required.", "description": "Positive safe integer; defaults to host parallelism, falling back to 1.", "guides": [ "/guides/typescript", "/guides/workers", "/guides/workers/messages", "/guides/workers/cancellation" ] }, { "name": "PoolOptions.maxQueuedTasks", "kind": "member", "signature": "maxQueuedTasks?: number;", "module": "maligator:workers", "url": "/api/workers#PoolOptions.maxQueuedTasks", "availability": "Experimental; no surface flag required.", "description": "Nonnegative safe integer; defaults to four times size. Zero disables the waiting queue.", "guides": [ "/guides/typescript", "/guides/workers", "/guides/workers/messages", "/guides/workers/cancellation" ] }, { "name": "PoolOptions.maxQueuedBytes", "kind": "member", "signature": "maxQueuedBytes?: number;", "module": "maligator:workers", "url": "/api/workers#PoolOptions.maxQueuedBytes", "availability": "Experimental; no surface flag required.", "description": "Positive safe integer in bytes; defaults to 67108864 (64 MiB).", "guides": [ "/guides/typescript", "/guides/workers", "/guides/workers/messages", "/guides/workers/cancellation" ] }, { "name": "PoolOptions.maxMessageBytes", "kind": "member", "signature": "maxMessageBytes?: number;", "module": "maligator:workers", "url": "/api/workers#PoolOptions.maxMessageBytes", "availability": "Experimental; no surface flag required.", "description": "Positive safe integer in bytes; defaults to maxQueuedBytes.", "guides": [ "/guides/typescript", "/guides/workers", "/guides/workers/messages", "/guides/workers/cancellation" ] }, { "name": "PoolOptions.name", "kind": "member", "signature": "name?: string;", "module": "maligator:workers", "url": "/api/workers#PoolOptions.name", "availability": "Experimental; no surface flag required.", "description": "Worker name prefix; each worker receives a one-based suffix.", "guides": [ "/guides/typescript", "/guides/workers", "/guides/workers/messages", "/guides/workers/cancellation" ] }, { "name": "RunOptions", "kind": "type", "signature": "type RunOptions = {\n /** Already-aborted signals throw before admission. Running cancellation is cooperative. */\n signal?: AbortSignal;\n /** Ownership moves synchronously on successful admission; rejection leaves values unchanged. */\n transfer?: ReadonlyArray;\n};", "module": "maligator:workers", "url": "/api/workers#RunOptions", "description": "The transfer list commits synchronously when run returns normally. Validation, saturation, closed pools and already-aborted signals throw before admission.", "availability": "experimental", "guides": [ "/guides/typescript", "/guides/workers", "/guides/workers/messages", "/guides/workers/cancellation" ] }, { "name": "RunOptions.signal", "kind": "member", "signature": "signal?: AbortSignal;", "module": "maligator:workers", "url": "/api/workers#RunOptions.signal", "availability": "Experimental; no surface flag required.", "description": "Already-aborted signals throw before admission. Running cancellation is cooperative.", "guides": [ "/guides/typescript", "/guides/workers", "/guides/workers/messages", "/guides/workers/cancellation" ] }, { "name": "RunOptions.transfer", "kind": "member", "signature": "transfer?: ReadonlyArray;", "module": "maligator:workers", "url": "/api/workers#RunOptions.transfer", "availability": "Experimental; no surface flag required.", "description": "Ownership moves synchronously on successful admission; rejection leaves values unchanged.", "guides": [ "/guides/typescript", "/guides/workers", "/guides/workers/messages", "/guides/workers/cancellation" ] }, { "name": "MapOptions", "kind": "type", "signature": "type MapOptions = {\n /** Cancels only work owned by this map; running tasks must cooperate. */\n signal?: AbortSignal;\n /** Positive safe integer; defaults to pool size. Bounds pulled inputs and buffered results together. */\n window?: number;\n /** Called for each input before admission to choose values whose ownership moves. */\n transfer?: (args: Args, index: number) => ReadonlyArray;\n};", "module": "maligator:workers", "url": "/api/workers#MapOptions", "description": "The window bounds pulled inputs and buffered results together. Results are yielded in input order; iterator return cancels this map's work and closes its input.", "availability": "experimental", "guides": [ "/guides/typescript", "/guides/workers", "/guides/workers/messages", "/guides/workers/cancellation" ] }, { "name": "MapOptions.signal", "kind": "member", "signature": "signal?: AbortSignal;", "module": "maligator:workers", "url": "/api/workers#MapOptions.signal", "availability": "Experimental; no surface flag required.", "description": "Cancels only work owned by this map; running tasks must cooperate.", "guides": [ "/guides/typescript", "/guides/workers", "/guides/workers/messages", "/guides/workers/cancellation" ] }, { "name": "MapOptions.window", "kind": "member", "signature": "window?: number;", "module": "maligator:workers", "url": "/api/workers#MapOptions.window", "availability": "Experimental; no surface flag required.", "description": "Positive safe integer; defaults to pool size. Bounds pulled inputs and buffered results together.", "guides": [ "/guides/typescript", "/guides/workers", "/guides/workers/messages", "/guides/workers/cancellation" ] }, { "name": "MapOptions.transfer", "kind": "member", "signature": "transfer?: (args: Args, index: number) => ReadonlyArray;", "module": "maligator:workers", "url": "/api/workers#MapOptions.transfer", "availability": "Experimental; no surface flag required.", "description": "Called for each input before admission to choose values whose ownership moves.", "guides": [ "/guides/typescript", "/guides/workers", "/guides/workers/messages", "/guides/workers/cancellation" ] }, { "name": "PoolStats", "kind": "type", "signature": "type PoolStats = { readonly size: number; readonly active: number; readonly queued: number; readonly completed: number; readonly failed: number; readonly cancelled: number };", "module": "maligator:workers", "url": "/api/workers#PoolStats", "description": "A snapshot of this pool's scheduling and settled operations.", "availability": "experimental", "guides": [ "/guides/typescript", "/guides/workers", "/guides/workers/messages", "/guides/workers/cancellation" ] }, { "name": "PoolStats.size", "kind": "member", "signature": "readonly size: number;", "module": "maligator:workers", "url": "/api/workers#PoolStats.size", "availability": "Experimental; no surface flag required.", "description": "", "guides": [ "/guides/typescript", "/guides/workers", "/guides/workers/messages", "/guides/workers/cancellation" ] }, { "name": "PoolStats.active", "kind": "member", "signature": "readonly active: number;", "module": "maligator:workers", "url": "/api/workers#PoolStats.active", "availability": "Experimental; no surface flag required.", "description": "", "guides": [ "/guides/typescript", "/guides/workers", "/guides/workers/messages", "/guides/workers/cancellation" ] }, { "name": "PoolStats.queued", "kind": "member", "signature": "readonly queued: number;", "module": "maligator:workers", "url": "/api/workers#PoolStats.queued", "availability": "Experimental; no surface flag required.", "description": "", "guides": [ "/guides/typescript", "/guides/workers", "/guides/workers/messages", "/guides/workers/cancellation" ] }, { "name": "PoolStats.completed", "kind": "member", "signature": "readonly completed: number;", "module": "maligator:workers", "url": "/api/workers#PoolStats.completed", "availability": "Experimental; no surface flag required.", "description": "", "guides": [ "/guides/typescript", "/guides/workers", "/guides/workers/messages", "/guides/workers/cancellation" ] }, { "name": "PoolStats.failed", "kind": "member", "signature": "readonly failed: number;", "module": "maligator:workers", "url": "/api/workers#PoolStats.failed", "availability": "Experimental; no surface flag required.", "description": "", "guides": [ "/guides/typescript", "/guides/workers", "/guides/workers/messages", "/guides/workers/cancellation" ] }, { "name": "PoolStats.cancelled", "kind": "member", "signature": "readonly cancelled: number", "module": "maligator:workers", "url": "/api/workers#PoolStats.cancelled", "availability": "Experimental; no surface flag required.", "description": "", "guides": [ "/guides/typescript", "/guides/workers", "/guides/workers/messages", "/guides/workers/cancellation" ] }, { "name": "WorkerPool", "kind": "type", "signature": "type WorkerPool = {\n /** Resolves after every worker evaluates the entry; rejects on startup failure. */\n readonly ready: Promise;\n /** Throws on failed admission; returns a promise for the accepted task's result or failure. */\n run>(name: Key, args: TaskArgs, options?: RunOptions): Promise>;\n /** Yields in input order. Returning from the iterator cancels its work and closes its input. */\n map>(name: Key, args: Iterable> | AsyncIterable>, options?: MapOptions>): AsyncIterable>;\n /** Stops admission, drains accepted tasks, then joins every worker. Idempotent. */\n close(): Promise;\n /** Rejects outstanding tasks with AbortError; joins workers after running tasks cooperate and settle. */\n terminate(): Promise;\n /** Returns a scheduling snapshot; counts are not a subscription. */\n stats(): PoolStats;\n /** Keeps the process alive while pool workers exist; returns this pool. */\n ref(): WorkerPool;\n /** Allows the process to exit without waiting for this pool; returns this pool. */\n unref(): WorkerPool;\n /** Reports whether this pool currently keeps the process alive. */\n hasRef(): boolean;\n};", "module": "maligator:workers", "url": "/api/workers#WorkerPool", "description": "A bounded task scheduler over isolated persistent workers. Each worker executes one task through asynchronous settlement. No accepted task is replayed after worker failure.", "availability": "experimental", "guides": [ "/guides/typescript", "/guides/workers", "/guides/workers/messages", "/guides/workers/cancellation" ] }, { "name": "WorkerPool.ready", "kind": "member", "signature": "readonly ready: Promise;", "module": "maligator:workers", "url": "/api/workers#WorkerPool.ready", "availability": "Experimental; no surface flag required.", "description": "Resolves after every worker evaluates the entry; rejects on startup failure.", "guides": [ "/guides/typescript", "/guides/workers", "/guides/workers/messages", "/guides/workers/cancellation" ] }, { "name": "WorkerPool.run", "kind": "member", "signature": "run>(name: Key, args: TaskArgs, options?: RunOptions): Promise>;", "module": "maligator:workers", "url": "/api/workers#WorkerPool.run", "availability": "Experimental; no surface flag required.", "description": "Throws on failed admission; returns a promise for the accepted task's result or failure.", "guides": [ "/guides/typescript", "/guides/workers", "/guides/workers/messages", "/guides/workers/cancellation" ] }, { "name": "WorkerPool.map", "kind": "member", "signature": "map>(name: Key, args: Iterable> | AsyncIterable>, options?: MapOptions>): AsyncIterable>;", "module": "maligator:workers", "url": "/api/workers#WorkerPool.map", "availability": "Experimental; no surface flag required.", "description": "Yields in input order. Returning from the iterator cancels its work and closes its input.", "guides": [ "/guides/typescript", "/guides/workers", "/guides/workers/messages", "/guides/workers/cancellation" ] }, { "name": "WorkerPool.close", "kind": "member", "signature": "close(): Promise;", "module": "maligator:workers", "url": "/api/workers#WorkerPool.close", "availability": "Experimental; no surface flag required.", "description": "Stops admission, drains accepted tasks, then joins every worker. Idempotent.", "guides": [ "/guides/typescript", "/guides/workers", "/guides/workers/messages", "/guides/workers/cancellation" ] }, { "name": "WorkerPool.terminate", "kind": "member", "signature": "terminate(): Promise;", "module": "maligator:workers", "url": "/api/workers#WorkerPool.terminate", "availability": "Experimental; no surface flag required.", "description": "Rejects outstanding tasks with AbortError; joins workers after running tasks cooperate and settle.", "guides": [ "/guides/typescript", "/guides/workers", "/guides/workers/messages", "/guides/workers/cancellation" ] }, { "name": "WorkerPool.stats", "kind": "member", "signature": "stats(): PoolStats;", "module": "maligator:workers", "url": "/api/workers#WorkerPool.stats", "availability": "Experimental; no surface flag required.", "description": "Returns a scheduling snapshot; counts are not a subscription.", "guides": [ "/guides/typescript", "/guides/workers", "/guides/workers/messages", "/guides/workers/cancellation" ] }, { "name": "WorkerPool.ref", "kind": "member", "signature": "ref(): WorkerPool;", "module": "maligator:workers", "url": "/api/workers#WorkerPool.ref", "availability": "Experimental; no surface flag required.", "description": "Keeps the process alive while pool workers exist; returns this pool.", "guides": [ "/guides/typescript", "/guides/workers", "/guides/workers/messages", "/guides/workers/cancellation" ] }, { "name": "WorkerPool.unref", "kind": "member", "signature": "unref(): WorkerPool;", "module": "maligator:workers", "url": "/api/workers#WorkerPool.unref", "availability": "Experimental; no surface flag required.", "description": "Allows the process to exit without waiting for this pool; returns this pool.", "guides": [ "/guides/typescript", "/guides/workers", "/guides/workers/messages", "/guides/workers/cancellation" ] }, { "name": "WorkerPool.hasRef", "kind": "member", "signature": "hasRef(): boolean;", "module": "maligator:workers", "url": "/api/workers#WorkerPool.hasRef", "availability": "Experimental; no surface flag required.", "description": "Reports whether this pool currently keeps the process alive.", "guides": [ "/guides/typescript", "/guides/workers", "/guides/workers/messages", "/guides/workers/cancellation" ] }, { "name": "WorkerExit", "kind": "type", "signature": "type WorkerExit = { readonly id: number; readonly code: number; readonly reason: 'completed' | 'terminated' | 'error'; readonly error?: unknown };", "module": "maligator:workers", "url": "/api/workers#WorkerExit", "description": "A terminal record published only after the native worker is joined and its slot is released.", "availability": "experimental", "guides": [ "/guides/typescript", "/guides/workers", "/guides/workers/messages", "/guides/workers/cancellation" ] }, { "name": "WorkerExit.id", "kind": "member", "signature": "readonly id: number;", "module": "maligator:workers", "url": "/api/workers#WorkerExit.id", "availability": "Experimental; no surface flag required.", "description": "", "guides": [ "/guides/typescript", "/guides/workers", "/guides/workers/messages", "/guides/workers/cancellation" ] }, { "name": "WorkerExit.code", "kind": "member", "signature": "readonly code: number;", "module": "maligator:workers", "url": "/api/workers#WorkerExit.code", "availability": "Experimental; no surface flag required.", "description": "", "guides": [ "/guides/typescript", "/guides/workers", "/guides/workers/messages", "/guides/workers/cancellation" ] }, { "name": "WorkerExit.reason", "kind": "member", "signature": "readonly reason: 'completed' | 'terminated' | 'error';", "module": "maligator:workers", "url": "/api/workers#WorkerExit.reason", "availability": "Experimental; no surface flag required.", "description": "", "guides": [ "/guides/typescript", "/guides/workers", "/guides/workers/messages", "/guides/workers/cancellation" ] }, { "name": "WorkerExit.error", "kind": "member", "signature": "readonly error?: unknown", "module": "maligator:workers", "url": "/api/workers#WorkerExit.error", "availability": "Experimental; no surface flag required.", "description": "", "guides": [ "/guides/typescript", "/guides/workers", "/guides/workers/messages", "/guides/workers/cancellation" ] }, { "name": "WorkerOptions", "kind": "type", "signature": "type WorkerOptions = {\n name?: string;\n /** Cloned into workerData before startup; later caller mutations are not shared. */\n data?: unknown;\n /** Values moved as part of startup-data admission. */\n transfer?: ReadonlyArray;\n /** Positive safe integer, at most 4294967295; defaults to 4096 messages per endpoint. */\n maxQueuedMessages?: number;\n /** Positive safe integer in bytes; defaults to 67108864 (64 MiB) per endpoint. */\n maxQueuedBytes?: number;\n /** Positive safe integer in bytes; defaults to 16777216 (16 MiB) per message. */\n maxMessageBytes?: number;\n};", "module": "maligator:workers", "url": "/api/workers#WorkerOptions", "description": "Worker data is snapshotted before startup. The native host bounds live workers and message admission process-wide.", "availability": "experimental", "guides": [ "/guides/typescript", "/guides/workers", "/guides/workers/messages", "/guides/workers/cancellation" ] }, { "name": "WorkerOptions.name", "kind": "member", "signature": "name?: string;", "module": "maligator:workers", "url": "/api/workers#WorkerOptions.name", "availability": "Experimental; no surface flag required.", "description": "", "guides": [ "/guides/typescript", "/guides/workers", "/guides/workers/messages", "/guides/workers/cancellation" ] }, { "name": "WorkerOptions.data", "kind": "member", "signature": "data?: unknown;", "module": "maligator:workers", "url": "/api/workers#WorkerOptions.data", "availability": "Experimental; no surface flag required.", "description": "Cloned into workerData before startup; later caller mutations are not shared.", "guides": [ "/guides/typescript", "/guides/workers", "/guides/workers/messages", "/guides/workers/cancellation" ] }, { "name": "WorkerOptions.transfer", "kind": "member", "signature": "transfer?: ReadonlyArray;", "module": "maligator:workers", "url": "/api/workers#WorkerOptions.transfer", "availability": "Experimental; no surface flag required.", "description": "Values moved as part of startup-data admission.", "guides": [ "/guides/typescript", "/guides/workers", "/guides/workers/messages", "/guides/workers/cancellation" ] }, { "name": "WorkerOptions.maxQueuedMessages", "kind": "member", "signature": "maxQueuedMessages?: number;", "module": "maligator:workers", "url": "/api/workers#WorkerOptions.maxQueuedMessages", "availability": "Experimental; no surface flag required.", "description": "Positive safe integer, at most 4294967295; defaults to 4096 messages per endpoint.", "guides": [ "/guides/typescript", "/guides/workers", "/guides/workers/messages", "/guides/workers/cancellation" ] }, { "name": "WorkerOptions.maxQueuedBytes", "kind": "member", "signature": "maxQueuedBytes?: number;", "module": "maligator:workers", "url": "/api/workers#WorkerOptions.maxQueuedBytes", "availability": "Experimental; no surface flag required.", "description": "Positive safe integer in bytes; defaults to 67108864 (64 MiB) per endpoint.", "guides": [ "/guides/typescript", "/guides/workers", "/guides/workers/messages", "/guides/workers/cancellation" ] }, { "name": "WorkerOptions.maxMessageBytes", "kind": "member", "signature": "maxMessageBytes?: number;", "module": "maligator:workers", "url": "/api/workers#WorkerOptions.maxMessageBytes", "availability": "Experimental; no surface flag required.", "description": "Positive safe integer in bytes; defaults to 16777216 (16 MiB) per message.", "guides": [ "/guides/typescript", "/guides/workers", "/guides/workers/messages", "/guides/workers/cancellation" ] }, { "name": "MessageChannelOptions", "kind": "type", "signature": "type MessageChannelOptions = {\n /** Positive safe integer, at most 4294967295; defaults to 4096 messages per endpoint. */\n maxQueuedMessages?: number;\n /** Positive safe integer in bytes; defaults to 67108864 (64 MiB) per endpoint. */\n maxQueuedBytes?: number;\n /** Positive safe integer in bytes; defaults to 16777216 (16 MiB) per message. */\n maxMessageBytes?: number;\n};", "module": "maligator:workers", "url": "/api/workers#MessageChannelOptions", "description": "Each endpoint bounds its pending message count and bytes. Rejection leaves the sender's transferables unchanged.", "availability": "experimental", "guides": [ "/guides/typescript", "/guides/workers", "/guides/workers/messages", "/guides/workers/cancellation" ] }, { "name": "MessageChannelOptions.maxQueuedMessages", "kind": "member", "signature": "maxQueuedMessages?: number;", "module": "maligator:workers", "url": "/api/workers#MessageChannelOptions.maxQueuedMessages", "availability": "Experimental; no surface flag required.", "description": "Positive safe integer, at most 4294967295; defaults to 4096 messages per endpoint.", "guides": [ "/guides/typescript", "/guides/workers", "/guides/workers/messages", "/guides/workers/cancellation" ] }, { "name": "MessageChannelOptions.maxQueuedBytes", "kind": "member", "signature": "maxQueuedBytes?: number;", "module": "maligator:workers", "url": "/api/workers#MessageChannelOptions.maxQueuedBytes", "availability": "Experimental; no surface flag required.", "description": "Positive safe integer in bytes; defaults to 67108864 (64 MiB) per endpoint.", "guides": [ "/guides/typescript", "/guides/workers", "/guides/workers/messages", "/guides/workers/cancellation" ] }, { "name": "MessageChannelOptions.maxMessageBytes", "kind": "member", "signature": "maxMessageBytes?: number;", "module": "maligator:workers", "url": "/api/workers#MessageChannelOptions.maxMessageBytes", "availability": "Experimental; no surface flag required.", "description": "Positive safe integer in bytes; defaults to 16777216 (16 MiB) per message.", "guides": [ "/guides/typescript", "/guides/workers", "/guides/workers/messages", "/guides/workers/cancellation" ] }, { "name": "MessagePort", "kind": "type", "signature": "interface MessagePort extends EventTarget {\n /** Clones and admits a message synchronously. Transfer commits only after successful validation/admission. */\n postMessage(value: Send, transfer?: ReadonlyArray): void;\n /** Setting this handler starts delivery. addEventListener listeners need start(). */\n onmessage: ((event: MessageEvent) => void) | null;\n /** Receives message decoding failures in the receiving isolate. */\n onmessageerror: ((event: MessageEvent) => void) | null;\n /** Enables delivery to event listeners; repeated calls are harmless. */\n start(): void;\n /** Discards queued messages and closes this endpoint. */\n close(): void;\n /** Keeps the receiving isolate alive; returns this port. */\n ref(): MessagePort;\n /** Allows the receiving isolate to exit; returns this port. */\n unref(): MessagePort;\n hasRef(): boolean;\n}", "module": "maligator:workers", "url": "/api/workers#MessagePort.type", "description": "An ordered bidirectional endpoint with transactional transfer and bounded queues. Message listeners and values are owned by the receiving isolate.", "availability": "experimental", "guides": [ "/guides/typescript", "/guides/workers", "/guides/workers/messages", "/guides/workers/cancellation" ] }, { "name": "MessagePort.postMessage", "kind": "member", "signature": "postMessage(value: Send, transfer?: ReadonlyArray): void;", "module": "maligator:workers", "url": "/api/workers#MessagePort.postMessage", "availability": "Experimental; no surface flag required.", "description": "Clones and admits a message synchronously. Transfer commits only after successful validation/admission.", "guides": [ "/guides/typescript", "/guides/workers", "/guides/workers/messages", "/guides/workers/cancellation" ] }, { "name": "MessagePort.onmessage", "kind": "member", "signature": "onmessage: ((event: MessageEvent) => void) | null;", "module": "maligator:workers", "url": "/api/workers#MessagePort.onmessage", "availability": "Experimental; no surface flag required.", "description": "Setting this handler starts delivery. addEventListener listeners need start().", "guides": [ "/guides/typescript", "/guides/workers", "/guides/workers/messages", "/guides/workers/cancellation" ] }, { "name": "MessagePort.onmessageerror", "kind": "member", "signature": "onmessageerror: ((event: MessageEvent) => void) | null;", "module": "maligator:workers", "url": "/api/workers#MessagePort.onmessageerror", "availability": "Experimental; no surface flag required.", "description": "Receives message decoding failures in the receiving isolate.", "guides": [ "/guides/typescript", "/guides/workers", "/guides/workers/messages", "/guides/workers/cancellation" ] }, { "name": "MessagePort.start", "kind": "member", "signature": "start(): void;", "module": "maligator:workers", "url": "/api/workers#MessagePort.start", "availability": "Experimental; no surface flag required.", "description": "Enables delivery to event listeners; repeated calls are harmless.", "guides": [ "/guides/typescript", "/guides/workers", "/guides/workers/messages", "/guides/workers/cancellation" ] }, { "name": "MessagePort.close", "kind": "member", "signature": "close(): void;", "module": "maligator:workers", "url": "/api/workers#MessagePort.close", "availability": "Experimental; no surface flag required.", "description": "Discards queued messages and closes this endpoint.", "guides": [ "/guides/typescript", "/guides/workers", "/guides/workers/messages", "/guides/workers/cancellation" ] }, { "name": "MessagePort.ref", "kind": "member", "signature": "ref(): MessagePort;", "module": "maligator:workers", "url": "/api/workers#MessagePort.ref", "availability": "Experimental; no surface flag required.", "description": "Keeps the receiving isolate alive; returns this port.", "guides": [ "/guides/typescript", "/guides/workers", "/guides/workers/messages", "/guides/workers/cancellation" ] }, { "name": "MessagePort.unref", "kind": "member", "signature": "unref(): MessagePort;", "module": "maligator:workers", "url": "/api/workers#MessagePort.unref", "availability": "Experimental; no surface flag required.", "description": "Allows the receiving isolate to exit; returns this port.", "guides": [ "/guides/typescript", "/guides/workers", "/guides/workers/messages", "/guides/workers/cancellation" ] }, { "name": "MessagePort.hasRef", "kind": "member", "signature": "hasRef(): boolean;", "module": "maligator:workers", "url": "/api/workers#MessagePort.hasRef", "availability": "Experimental; no surface flag required.", "description": "", "guides": [ "/guides/typescript", "/guides/workers", "/guides/workers/messages", "/guides/workers/cancellation" ] }, { "name": "MessageChannel", "kind": "type", "signature": "type MessageChannel = { readonly port1: MessagePort; readonly port2: MessagePort };", "module": "maligator:workers", "url": "/api/workers#MessageChannel.type", "description": "A standalone channel whose endpoints may be transferred to workers.", "availability": "experimental", "guides": [ "/guides/typescript", "/guides/workers", "/guides/workers/messages", "/guides/workers/cancellation" ] }, { "name": "MessageChannel.port1", "kind": "member", "signature": "readonly port1: MessagePort;", "module": "maligator:workers", "url": "/api/workers#MessageChannel.port1", "availability": "Experimental; no surface flag required.", "description": "", "guides": [ "/guides/typescript", "/guides/workers", "/guides/workers/messages", "/guides/workers/cancellation" ] }, { "name": "MessageChannel.port2", "kind": "member", "signature": "readonly port2: MessagePort", "module": "maligator:workers", "url": "/api/workers#MessageChannel.port2", "availability": "Experimental; no surface flag required.", "description": "", "guides": [ "/guides/typescript", "/guides/workers", "/guides/workers/messages", "/guides/workers/cancellation" ] }, { "name": "Worker", "kind": "type", "signature": "type Worker = EventTarget & {\n readonly id: number;\n /** Resolves after entry evaluation; rejects on startup failure. */\n readonly ready: Promise;\n /** Resolves with a terminal record after the native thread is joined and its slot released. */\n readonly closed: Promise;\n readonly port: MessagePort;\n /** Requests shutdown and resolves after thread reaping. */\n terminate(): Promise;\n ref(): Worker;\n unref(): Worker;\n hasRef(): boolean;\n};", "module": "maligator:workers", "url": "/api/workers#Worker.type", "description": "A long-lived isolated module and its parent communication port. Startup completes after module evaluation; shutdown completes after native thread reaping.", "availability": "experimental", "guides": [ "/guides/typescript", "/guides/workers", "/guides/workers/messages", "/guides/workers/cancellation" ] }, { "name": "Worker.id", "kind": "member", "signature": "readonly id: number;", "module": "maligator:workers", "url": "/api/workers#Worker.id", "availability": "Experimental; no surface flag required.", "description": "", "guides": [ "/guides/typescript", "/guides/workers", "/guides/workers/messages", "/guides/workers/cancellation" ] }, { "name": "Worker.ready", "kind": "member", "signature": "readonly ready: Promise;", "module": "maligator:workers", "url": "/api/workers#Worker.ready", "availability": "Experimental; no surface flag required.", "description": "Resolves after entry evaluation; rejects on startup failure.", "guides": [ "/guides/typescript", "/guides/workers", "/guides/workers/messages", "/guides/workers/cancellation" ] }, { "name": "Worker.closed", "kind": "member", "signature": "readonly closed: Promise;", "module": "maligator:workers", "url": "/api/workers#Worker.closed", "availability": "Experimental; no surface flag required.", "description": "Resolves with a terminal record after the native thread is joined and its slot released.", "guides": [ "/guides/typescript", "/guides/workers", "/guides/workers/messages", "/guides/workers/cancellation" ] }, { "name": "Worker.port", "kind": "member", "signature": "readonly port: MessagePort;", "module": "maligator:workers", "url": "/api/workers#Worker.port", "availability": "Experimental; no surface flag required.", "description": "", "guides": [ "/guides/typescript", "/guides/workers", "/guides/workers/messages", "/guides/workers/cancellation" ] }, { "name": "Worker.terminate", "kind": "member", "signature": "terminate(): Promise;", "module": "maligator:workers", "url": "/api/workers#Worker.terminate", "availability": "Experimental; no surface flag required.", "description": "Requests shutdown and resolves after thread reaping.", "guides": [ "/guides/typescript", "/guides/workers", "/guides/workers/messages", "/guides/workers/cancellation" ] }, { "name": "Worker.ref", "kind": "member", "signature": "ref(): Worker;", "module": "maligator:workers", "url": "/api/workers#Worker.ref", "availability": "Experimental; no surface flag required.", "description": "", "guides": [ "/guides/typescript", "/guides/workers", "/guides/workers/messages", "/guides/workers/cancellation" ] }, { "name": "Worker.unref", "kind": "member", "signature": "unref(): Worker;", "module": "maligator:workers", "url": "/api/workers#Worker.unref", "availability": "Experimental; no surface flag required.", "description": "", "guides": [ "/guides/typescript", "/guides/workers", "/guides/workers/messages", "/guides/workers/cancellation" ] }, { "name": "Worker.hasRef", "kind": "member", "signature": "hasRef(): boolean;", "module": "maligator:workers", "url": "/api/workers#Worker.hasRef", "availability": "Experimental; no surface flag required.", "description": "", "guides": [ "/guides/typescript", "/guides/workers", "/guides/workers/messages", "/guides/workers/cancellation" ] }, { "name": "test", "kind": "export", "signature": "export const test: TestFunction;", "module": "maligator:test", "url": "/api/test#test", "description": "Register a test in the current suite.", "availability": "experimental", "guides": [ "/guides/typescript", "/guides/testing" ] }, { "name": "describe", "kind": "export", "signature": "export const describe: DescribeFunction;", "module": "maligator:test", "url": "/api/test#describe", "description": "Register a nested suite in the current suite.", "availability": "experimental", "guides": [ "/guides/typescript", "/guides/testing" ] }, { "name": "expect", "kind": "export", "signature": "export const expect: ExpectFunction;", "module": "maligator:test", "url": "/api/test#expect", "description": "Create fluent matchers for a received value.", "availability": "experimental", "guides": [ "/guides/typescript", "/guides/testing" ] }, { "name": "beforeAll", "kind": "export", "signature": "export const beforeAll: (callback: HookCallback) => void;", "module": "maligator:test", "url": "/api/test#beforeAll", "description": "Run once before tests in the current suite.", "availability": "experimental", "guides": [ "/guides/typescript", "/guides/testing" ] }, { "name": "afterAll", "kind": "export", "signature": "export const afterAll: (callback: HookCallback) => void;", "module": "maligator:test", "url": "/api/test#afterAll", "description": "Run once after tests in the current suite, including after test failures.", "availability": "experimental", "guides": [ "/guides/typescript", "/guides/testing" ] }, { "name": "beforeEach", "kind": "export", "signature": "export const beforeEach: (callback: HookCallback) => void;", "module": "maligator:test", "url": "/api/test#beforeEach", "description": "Run before every selected descendant test. Ancestor hooks run before hooks\ndeclared by a nested suite.", "availability": "experimental", "guides": [ "/guides/typescript", "/guides/testing" ] }, { "name": "afterEach", "kind": "export", "signature": "export const afterEach: (callback: HookCallback) => void;", "module": "maligator:test", "url": "/api/test#afterEach", "description": "Run after every selected descendant test. Nested-suite hooks run before\nancestor hooks.", "availability": "experimental", "guides": [ "/guides/typescript", "/guides/testing" ] }, { "name": "TestCallback", "kind": "type", "signature": "type TestCallback = () => unknown;", "module": "maligator:test", "url": "/api/test#TestCallback", "description": "A test or hook body. Maligator waits for a returned promise or thenable before advancing the lifecycle.", "availability": "experimental", "guides": [ "/guides/typescript", "/guides/testing" ] }, { "name": "HookCallback", "kind": "type", "signature": "type HookCallback = TestCallback;", "module": "maligator:test", "url": "/api/test#HookCallback", "description": "A lifecycle hook body, with the same async completion contract as a test.", "availability": "experimental", "guides": [ "/guides/typescript", "/guides/testing" ] }, { "name": "Constructor", "kind": "type", "signature": "type Constructor = abstract new (...args: Array) => unknown;", "module": "maligator:test", "url": "/api/test#Constructor", "description": "A constructable value accepted by `expect.any`.", "availability": "experimental", "guides": [ "/guides/typescript", "/guides/testing" ] }, { "name": "AsymmetricMatcher", "kind": "type", "signature": "type AsymmetricMatcher = {\n\t\treadonly __maligator_asymmetric__: string;\n\t};", "module": "maligator:test", "url": "/api/test#AsymmetricMatcher", "description": "Opaque partial-match value produced by helpers such as `expect.objectContaining`. It may be nested inside `toEqual`, `toStrictEqual`, and `toMatchObject` expectations.", "availability": "experimental", "guides": [ "/guides/typescript", "/guides/testing" ] }, { "name": "AsymmetricMatcher.__maligator_asymmetric__", "kind": "member", "signature": "readonly __maligator_asymmetric__: string;", "module": "maligator:test", "url": "/api/test#AsymmetricMatcher.__maligator_asymmetric__", "availability": "Experimental; no surface flag required.", "description": "", "guides": [ "/guides/typescript", "/guides/testing" ] }, { "name": "Matchers", "kind": "type", "signature": "type Matchers = {\n\t\t/** Negate the following matcher. */\n\t\treadonly not: Matchers;\n\t\t/** Wait for the received promise to fulfill, then match its value. */\n\t\treadonly resolves: AsyncMatchers;\n\t\t/** Wait for the received promise to reject, then match its reason. */\n\t\treadonly rejects: AsyncMatchers;\n\t\t/** Require ECMAScript `Object.is` identity. */\n\t\ttoBe(expected: unknown): void;\n\t\t/** Recursively compare enumerable object properties and array elements. */\n\t\ttoEqual(expected: unknown): void;\n\t\t/**\n\t\t * Recursively compare values while also requiring matching prototypes and\n\t\t * matching sparse-array holes.\n\t\t */\n\t\ttoStrictEqual(expected: unknown): void;\n\t\t/** Require a value other than `undefined`. */\n\t\ttoBeDefined(): void;\n\t\t/** Require `undefined`. */\n\t\ttoBeUndefined(): void;\n\t\t/** Require `null`. */\n\t\ttoBeNull(): void;\n\t\t/** Require a truthy value. */\n\t\ttoBeTruthy(): void;\n\t\t/** Require a falsy value. */\n\t\ttoBeFalsy(): void;\n\t\t/** Require a string substring or an array element matched by identity. */\n\t\ttoContain(expected: unknown): void;\n\t\t/** Require a numeric `.length` equal to `expected`. */\n\t\ttoHaveLength(expected: number): void;\n\t\t/** Match a string against a substring or regular expression. */\n\t\ttoMatch(expected: string | RegExp): void;\n\t\t/** Recursively require the enumerable properties present in `expected`. */\n\t\ttoMatchObject(expected: object): void;\n\t\t/**\n\t\t * Invoke the received function and require it to throw. The optional\n\t\t * expectation may be a message substring, regular expression, error\n\t\t * constructor, or error instance.\n\t\t */\n\t\ttoThrow(\n\t\t\texpected?:\n\t\t\t\t| string\n\t\t\t\t| RegExp\n\t\t\t\t| Error\n\t\t\t\t| (abstract new (...args: Array) => Error),\n\t\t): void;\n\t};", "module": "maligator:test", "url": "/api/test#Matchers", "description": "Matchers for a synchronously received value.", "availability": "experimental", "guides": [ "/guides/typescript", "/guides/testing" ] }, { "name": "Matchers.not", "kind": "member", "signature": "readonly not: Matchers;", "module": "maligator:test", "url": "/api/test#Matchers.not", "availability": "Experimental; no surface flag required.", "description": "Negate the following matcher.", "guides": [ "/guides/typescript", "/guides/testing" ] }, { "name": "Matchers.resolves", "kind": "member", "signature": "readonly resolves: AsyncMatchers;", "module": "maligator:test", "url": "/api/test#Matchers.resolves", "availability": "Experimental; no surface flag required.", "description": "Wait for the received promise to fulfill, then match its value.", "guides": [ "/guides/typescript", "/guides/testing" ] }, { "name": "Matchers.rejects", "kind": "member", "signature": "readonly rejects: AsyncMatchers;", "module": "maligator:test", "url": "/api/test#Matchers.rejects", "availability": "Experimental; no surface flag required.", "description": "Wait for the received promise to reject, then match its reason.", "guides": [ "/guides/typescript", "/guides/testing" ] }, { "name": "Matchers.toBe", "kind": "member", "signature": "toBe(expected: unknown): void;", "module": "maligator:test", "url": "/api/test#Matchers.toBe", "availability": "Experimental; no surface flag required.", "description": "Require ECMAScript `Object.is` identity.", "guides": [ "/guides/typescript", "/guides/testing" ] }, { "name": "Matchers.toEqual", "kind": "member", "signature": "toEqual(expected: unknown): void;", "module": "maligator:test", "url": "/api/test#Matchers.toEqual", "availability": "Experimental; no surface flag required.", "description": "Recursively compare enumerable object properties and array elements.", "guides": [ "/guides/typescript", "/guides/testing" ] }, { "name": "Matchers.toStrictEqual", "kind": "member", "signature": "toStrictEqual(expected: unknown): void;", "module": "maligator:test", "url": "/api/test#Matchers.toStrictEqual", "availability": "Experimental; no surface flag required.", "description": "Recursively compare values while also requiring matching prototypes and\nmatching sparse-array holes.", "guides": [ "/guides/typescript", "/guides/testing" ] }, { "name": "Matchers.toBeDefined", "kind": "member", "signature": "toBeDefined(): void;", "module": "maligator:test", "url": "/api/test#Matchers.toBeDefined", "availability": "Experimental; no surface flag required.", "description": "Require a value other than `undefined`.", "guides": [ "/guides/typescript", "/guides/testing" ] }, { "name": "Matchers.toBeUndefined", "kind": "member", "signature": "toBeUndefined(): void;", "module": "maligator:test", "url": "/api/test#Matchers.toBeUndefined", "availability": "Experimental; no surface flag required.", "description": "Require `undefined`.", "guides": [ "/guides/typescript", "/guides/testing" ] }, { "name": "Matchers.toBeNull", "kind": "member", "signature": "toBeNull(): void;", "module": "maligator:test", "url": "/api/test#Matchers.toBeNull", "availability": "Experimental; no surface flag required.", "description": "Require `null`.", "guides": [ "/guides/typescript", "/guides/testing" ] }, { "name": "Matchers.toBeTruthy", "kind": "member", "signature": "toBeTruthy(): void;", "module": "maligator:test", "url": "/api/test#Matchers.toBeTruthy", "availability": "Experimental; no surface flag required.", "description": "Require a truthy value.", "guides": [ "/guides/typescript", "/guides/testing" ] }, { "name": "Matchers.toBeFalsy", "kind": "member", "signature": "toBeFalsy(): void;", "module": "maligator:test", "url": "/api/test#Matchers.toBeFalsy", "availability": "Experimental; no surface flag required.", "description": "Require a falsy value.", "guides": [ "/guides/typescript", "/guides/testing" ] }, { "name": "Matchers.toContain", "kind": "member", "signature": "toContain(expected: unknown): void;", "module": "maligator:test", "url": "/api/test#Matchers.toContain", "availability": "Experimental; no surface flag required.", "description": "Require a string substring or an array element matched by identity.", "guides": [ "/guides/typescript", "/guides/testing" ] }, { "name": "Matchers.toHaveLength", "kind": "member", "signature": "toHaveLength(expected: number): void;", "module": "maligator:test", "url": "/api/test#Matchers.toHaveLength", "availability": "Experimental; no surface flag required.", "description": "Require a numeric `.length` equal to `expected`.", "guides": [ "/guides/typescript", "/guides/testing" ] }, { "name": "Matchers.toMatch", "kind": "member", "signature": "toMatch(expected: string | RegExp): void;", "module": "maligator:test", "url": "/api/test#Matchers.toMatch", "availability": "Experimental; no surface flag required.", "description": "Match a string against a substring or regular expression.", "guides": [ "/guides/typescript", "/guides/testing" ] }, { "name": "Matchers.toMatchObject", "kind": "member", "signature": "toMatchObject(expected: object): void;", "module": "maligator:test", "url": "/api/test#Matchers.toMatchObject", "availability": "Experimental; no surface flag required.", "description": "Recursively require the enumerable properties present in `expected`.", "guides": [ "/guides/typescript", "/guides/testing" ] }, { "name": "Matchers.toThrow", "kind": "member", "signature": "toThrow(\n\t\t\texpected?:\n\t\t\t\t| string\n\t\t\t\t| RegExp\n\t\t\t\t| Error\n\t\t\t\t| (abstract new (...args: Array) => Error),\n\t\t): void;", "module": "maligator:test", "url": "/api/test#Matchers.toThrow", "availability": "Experimental; no surface flag required.", "description": "Invoke the received function and require it to throw. The optional\nexpectation may be a message substring, regular expression, error\nconstructor, or error instance.", "guides": [ "/guides/typescript", "/guides/testing" ] }, { "name": "AsyncMatchers", "kind": "type", "signature": "type AsyncMatchers = {\n\t\t/** Negate the following asynchronous matcher. */\n\t\treadonly not: AsyncMatchers;\n\t\ttoBe(expected: unknown): Promise;\n\t\ttoEqual(expected: unknown): Promise;\n\t\ttoStrictEqual(expected: unknown): Promise;\n\t\ttoBeDefined(): Promise;\n\t\ttoBeUndefined(): Promise;\n\t\ttoBeNull(): Promise;\n\t\ttoBeTruthy(): Promise;\n\t\ttoBeFalsy(): Promise;\n\t\ttoContain(expected: unknown): Promise;\n\t\ttoHaveLength(expected: number): Promise;\n\t\ttoMatch(expected: string | RegExp): Promise;\n\t\ttoMatchObject(expected: object): Promise;\n\t\ttoThrow(\n\t\t\texpected?:\n\t\t\t\t| string\n\t\t\t\t| RegExp\n\t\t\t\t| Error\n\t\t\t\t| (abstract new (...args: Array) => Error),\n\t\t): Promise;\n\t};", "module": "maligator:test", "url": "/api/test#AsyncMatchers", "description": "Promise-returning matcher surface exposed by `Matchers.resolves` and `Matchers.rejects`. Await these calls so the test cannot finish before the assertion.", "availability": "experimental", "guides": [ "/guides/typescript", "/guides/testing" ] }, { "name": "AsyncMatchers.not", "kind": "member", "signature": "readonly not: AsyncMatchers;", "module": "maligator:test", "url": "/api/test#AsyncMatchers.not", "availability": "Experimental; no surface flag required.", "description": "Negate the following asynchronous matcher.", "guides": [ "/guides/typescript", "/guides/testing" ] }, { "name": "AsyncMatchers.toBe", "kind": "member", "signature": "toBe(expected: unknown): Promise;", "module": "maligator:test", "url": "/api/test#AsyncMatchers.toBe", "availability": "Experimental; no surface flag required.", "description": "", "guides": [ "/guides/typescript", "/guides/testing" ] }, { "name": "AsyncMatchers.toEqual", "kind": "member", "signature": "toEqual(expected: unknown): Promise;", "module": "maligator:test", "url": "/api/test#AsyncMatchers.toEqual", "availability": "Experimental; no surface flag required.", "description": "", "guides": [ "/guides/typescript", "/guides/testing" ] }, { "name": "AsyncMatchers.toStrictEqual", "kind": "member", "signature": "toStrictEqual(expected: unknown): Promise;", "module": "maligator:test", "url": "/api/test#AsyncMatchers.toStrictEqual", "availability": "Experimental; no surface flag required.", "description": "", "guides": [ "/guides/typescript", "/guides/testing" ] }, { "name": "AsyncMatchers.toBeDefined", "kind": "member", "signature": "toBeDefined(): Promise;", "module": "maligator:test", "url": "/api/test#AsyncMatchers.toBeDefined", "availability": "Experimental; no surface flag required.", "description": "", "guides": [ "/guides/typescript", "/guides/testing" ] }, { "name": "AsyncMatchers.toBeUndefined", "kind": "member", "signature": "toBeUndefined(): Promise;", "module": "maligator:test", "url": "/api/test#AsyncMatchers.toBeUndefined", "availability": "Experimental; no surface flag required.", "description": "", "guides": [ "/guides/typescript", "/guides/testing" ] }, { "name": "AsyncMatchers.toBeNull", "kind": "member", "signature": "toBeNull(): Promise;", "module": "maligator:test", "url": "/api/test#AsyncMatchers.toBeNull", "availability": "Experimental; no surface flag required.", "description": "", "guides": [ "/guides/typescript", "/guides/testing" ] }, { "name": "AsyncMatchers.toBeTruthy", "kind": "member", "signature": "toBeTruthy(): Promise;", "module": "maligator:test", "url": "/api/test#AsyncMatchers.toBeTruthy", "availability": "Experimental; no surface flag required.", "description": "", "guides": [ "/guides/typescript", "/guides/testing" ] }, { "name": "AsyncMatchers.toBeFalsy", "kind": "member", "signature": "toBeFalsy(): Promise;", "module": "maligator:test", "url": "/api/test#AsyncMatchers.toBeFalsy", "availability": "Experimental; no surface flag required.", "description": "", "guides": [ "/guides/typescript", "/guides/testing" ] }, { "name": "AsyncMatchers.toContain", "kind": "member", "signature": "toContain(expected: unknown): Promise;", "module": "maligator:test", "url": "/api/test#AsyncMatchers.toContain", "availability": "Experimental; no surface flag required.", "description": "", "guides": [ "/guides/typescript", "/guides/testing" ] }, { "name": "AsyncMatchers.toHaveLength", "kind": "member", "signature": "toHaveLength(expected: number): Promise;", "module": "maligator:test", "url": "/api/test#AsyncMatchers.toHaveLength", "availability": "Experimental; no surface flag required.", "description": "", "guides": [ "/guides/typescript", "/guides/testing" ] }, { "name": "AsyncMatchers.toMatch", "kind": "member", "signature": "toMatch(expected: string | RegExp): Promise;", "module": "maligator:test", "url": "/api/test#AsyncMatchers.toMatch", "availability": "Experimental; no surface flag required.", "description": "", "guides": [ "/guides/typescript", "/guides/testing" ] }, { "name": "AsyncMatchers.toMatchObject", "kind": "member", "signature": "toMatchObject(expected: object): Promise;", "module": "maligator:test", "url": "/api/test#AsyncMatchers.toMatchObject", "availability": "Experimental; no surface flag required.", "description": "", "guides": [ "/guides/typescript", "/guides/testing" ] }, { "name": "AsyncMatchers.toThrow", "kind": "member", "signature": "toThrow(\n\t\t\texpected?:\n\t\t\t\t| string\n\t\t\t\t| RegExp\n\t\t\t\t| Error\n\t\t\t\t| (abstract new (...args: Array) => Error),\n\t\t): Promise;", "module": "maligator:test", "url": "/api/test#AsyncMatchers.toThrow", "availability": "Experimental; no surface flag required.", "description": "", "guides": [ "/guides/typescript", "/guides/testing" ] }, { "name": "ExpectFunction", "kind": "type", "signature": "type ExpectFunction = {\n\t\t/** Create matchers for `received`. The assertion position is captured here. */\n\t\t(received: unknown): Matchers;\n\t\t/** Match a primitive of the corresponding built-in kind or an instance. */\n\t\tany(constructorValue: Constructor): AsymmetricMatcher;\n\t\t/** Match any value except `null` and `undefined`. */\n\t\tanything(): AsymmetricMatcher;\n\t\t/** Match a string containing `pattern` or satisfying the regular expression. */\n\t\tstringMatching(pattern: string | RegExp): AsymmetricMatcher;\n\t\t/** Match an object containing all recursively matched properties in `value`. */\n\t\tobjectContaining(value: object): AsymmetricMatcher;\n\t\t/** Match an array containing a match for every element in `value`. */\n\t\tarrayContaining(value: Array): AsymmetricMatcher;\n\t};", "module": "maligator:test", "url": "/api/test#ExpectFunction", "description": "Assertion entrypoint and Maligator-owned asymmetric matcher factories.", "availability": "experimental", "guides": [ "/guides/typescript", "/guides/testing" ] }, { "name": "expect.any", "kind": "member", "signature": "any(constructorValue: Constructor): AsymmetricMatcher;", "module": "maligator:test", "url": "/api/test#expect.any", "availability": "Experimental; no surface flag required.", "description": "Match a primitive of the corresponding built-in kind or an instance.", "guides": [ "/guides/typescript", "/guides/testing" ] }, { "name": "expect.anything", "kind": "member", "signature": "anything(): AsymmetricMatcher;", "module": "maligator:test", "url": "/api/test#expect.anything", "availability": "Experimental; no surface flag required.", "description": "Match any value except `null` and `undefined`.", "guides": [ "/guides/typescript", "/guides/testing" ] }, { "name": "expect.stringMatching", "kind": "member", "signature": "stringMatching(pattern: string | RegExp): AsymmetricMatcher;", "module": "maligator:test", "url": "/api/test#expect.stringMatching", "availability": "Experimental; no surface flag required.", "description": "Match a string containing `pattern` or satisfying the regular expression.", "guides": [ "/guides/typescript", "/guides/testing" ] }, { "name": "expect.objectContaining", "kind": "member", "signature": "objectContaining(value: object): AsymmetricMatcher;", "module": "maligator:test", "url": "/api/test#expect.objectContaining", "availability": "Experimental; no surface flag required.", "description": "Match an object containing all recursively matched properties in `value`.", "guides": [ "/guides/typescript", "/guides/testing" ] }, { "name": "expect.arrayContaining", "kind": "member", "signature": "arrayContaining(value: Array): AsymmetricMatcher;", "module": "maligator:test", "url": "/api/test#expect.arrayContaining", "availability": "Experimental; no surface flag required.", "description": "Match an array containing a match for every element in `value`.", "guides": [ "/guides/typescript", "/guides/testing" ] }, { "name": "TestFunction", "kind": "type", "signature": "type TestFunction = {\n\t\t/** Register a test. Returned promises are awaited by the runner. */\n\t\t(name: string, callback: TestCallback): void;\n\t\t/** Register a skipped test without invoking its callback. */\n\t\tskip(name: string, callback: TestCallback): void;\n\t\t/** Register a named placeholder with no callback. */\n\t\ttodo(name: string): void;\n\t\t/**\n\t\t * Register a focused test. When any `.only` exists, non-focused tests are\n\t\t * skipped and the runner emits a warning.\n\t\t */\n\t\tonly(name: string, callback: TestCallback): void;\n\t\t/**\n\t\t * Register one test for each row. Use `%#` in `name` for the zero-based row\n\t\t * index. Array rows are spread into callback parameters.\n\t\t */\n\t\teach>(\n\t\t\trows: ReadonlyArray,\n\t\t): (name: string, callback: (...values: [...Row]) => unknown) => void;\n\t};", "module": "maligator:test", "url": "/api/test#TestFunction", "description": "Register tests in the current suite during module evaluation.", "availability": "experimental", "guides": [ "/guides/typescript", "/guides/testing" ] }, { "name": "test.skip", "kind": "member", "signature": "skip(name: string, callback: TestCallback): void;", "module": "maligator:test", "url": "/api/test#test.skip", "availability": "Experimental; no surface flag required.", "description": "Register a skipped test without invoking its callback.", "guides": [ "/guides/typescript", "/guides/testing" ] }, { "name": "test.todo", "kind": "member", "signature": "todo(name: string): void;", "module": "maligator:test", "url": "/api/test#test.todo", "availability": "Experimental; no surface flag required.", "description": "Register a named placeholder with no callback.", "guides": [ "/guides/typescript", "/guides/testing" ] }, { "name": "test.only", "kind": "member", "signature": "only(name: string, callback: TestCallback): void;", "module": "maligator:test", "url": "/api/test#test.only", "availability": "Experimental; no surface flag required.", "description": "Register a focused test. When any `.only` exists, non-focused tests are\nskipped and the runner emits a warning.", "guides": [ "/guides/typescript", "/guides/testing" ] }, { "name": "test.each", "kind": "member", "signature": "each>(\n\t\t\trows: ReadonlyArray,\n\t\t): (name: string, callback: (...values: [...Row]) => unknown) => void;", "module": "maligator:test", "url": "/api/test#test.each", "availability": "Experimental; no surface flag required.", "description": "Register one test for each row. Use `%#` in `name` for the zero-based row\nindex. Array rows are spread into callback parameters.", "guides": [ "/guides/typescript", "/guides/testing" ] }, { "name": "DescribeFunction", "kind": "type", "signature": "type DescribeFunction = {\n\t\t/** Register a suite. Suite callbacks must not return a promise. */\n\t\t(name: string, callback: () => void): void;\n\t\t/** Register a suite whose descendants are skipped. */\n\t\tskip(name: string, callback: () => void): void;\n\t\t/** Register a focused suite and emit the runner's focused-test warning. */\n\t\tonly(name: string, callback: () => void): void;\n\t};", "module": "maligator:test", "url": "/api/test#DescribeFunction", "description": "Register nested suites synchronously during module evaluation.", "availability": "experimental", "guides": [ "/guides/typescript", "/guides/testing" ] }, { "name": "describe.skip", "kind": "member", "signature": "skip(name: string, callback: () => void): void;", "module": "maligator:test", "url": "/api/test#describe.skip", "availability": "Experimental; no surface flag required.", "description": "Register a suite whose descendants are skipped.", "guides": [ "/guides/typescript", "/guides/testing" ] }, { "name": "describe.only", "kind": "member", "signature": "only(name: string, callback: () => void): void;", "module": "maligator:test", "url": "/api/test#describe.only", "availability": "Experimental; no surface flag required.", "description": "Register a focused suite and emit the runner's focused-test warning.", "guides": [ "/guides/typescript", "/guides/testing" ] }, { "name": "MaligatorMaterializeOptions", "kind": "type", "signature": "export interface MaligatorMaterializeOptions {\n\t/** Parent directory for the content-addressed materialization. Defaults to the OS temporary directory. */\n\tbaseDirectory?: string;\n}", "module": "global", "url": "/api/runtime#MaligatorMaterializeOptions", "availability": "Requires the corresponding host surface.", "description": "", "guides": [ "/guides/assets", "/guides/http" ] }, { "name": "MaligatorMaterializeOptions.baseDirectory", "kind": "member", "signature": "baseDirectory?: string;", "module": "global", "url": "/api/runtime#MaligatorMaterializeOptions.baseDirectory", "availability": "Requires the corresponding host surface.", "description": "Parent directory for the content-addressed materialization. Defaults to the OS temporary directory.", "guides": [ "/guides/assets", "/guides/http" ] }, { "name": "MaligatorAssets", "kind": "type", "signature": "export interface MaligatorAssets {\n\t/**\n\t * Atomically write a named snapshot and return its absolute file/directory path.\n\t * Completed materializations are reused by content identity. Unknown names,\n\t * invalid options, and filesystem failures throw synchronously.\n\t * @see https://maligator.ddv.tools/api/runtime#mal.assets.materialize\n\t */\n\tmaterialize(name: string, options?: MaligatorMaterializeOptions): string;\n}", "module": "global", "url": "/api/runtime#MaligatorAssets", "availability": "Requires the corresponding host surface.", "description": "", "guides": [ "/guides/assets", "/guides/http" ] }, { "name": "mal.assets.materialize", "kind": "member", "signature": "materialize(name: string, options?: MaligatorMaterializeOptions): string;", "module": "global", "url": "/api/runtime#mal.assets.materialize", "availability": "Requires the corresponding host surface.", "description": "Atomically write a named snapshot and return its absolute file/directory path.\nCompleted materializations are reused by content identity. Unknown names,\ninvalid options, and filesystem failures throw synchronously.", "guides": [ "/guides/assets", "/guides/http" ] }, { "name": "MaligatorRuntime", "kind": "type", "signature": "export interface MaligatorRuntime {\n\treadonly assets: MaligatorAssets;\n}", "module": "global", "url": "/api/runtime#MaligatorRuntime", "availability": "Requires the corresponding host surface.", "description": "", "guides": [ "/guides/assets", "/guides/http" ] }, { "name": "MaligatorRuntime.assets", "kind": "member", "signature": "readonly assets: MaligatorAssets;", "module": "global", "url": "/api/runtime#MaligatorRuntime.assets", "availability": "Requires the corresponding host surface.", "description": "", "guides": [ "/guides/assets", "/guides/http" ] }, { "name": "MaligatorServeOptions", "kind": "type", "signature": "export interface MaligatorServeOptions {\n\t/** Bind address. Defaults to 0.0.0.0; use 127.0.0.1 for a local-only listener. */\n\thostname?: string;\n\t/** TCP port, 0 through 65535. Defaults to 0, which asks the OS to choose a port. */\n\tport?: number;\n\t/** Handle a request with a Response or an awaited response. */\n\tfetch(request: Request): Response | PromiseLike;\n\t/** Header deadline in milliseconds; 0 also selects the default. Integer 0..2147483647.\n\t * @default 60000 */\n\theadersTimeout?: number;\n\t/** Request deadline in milliseconds; 0 also selects the default. Integer 0..2147483647.\n\t * @default 300000 */\n\trequestTimeout?: number;\n\t/** Idle keep-alive deadline in milliseconds; 0 also selects the default. Integer 0..2147483647.\n\t * @default 5000 */\n\tkeepAliveTimeout?: number;\n\t/** Concurrent connection limit; 0 also selects the default. Integer 0..2147483647.\n\t * @default 1024 */\n\tmaxConnections?: number;\n}", "module": "global", "url": "/api/runtime#MaligatorServeOptions", "availability": "Requires the corresponding host surface.", "description": "", "guides": [ "/guides/assets", "/guides/http" ] }, { "name": "MaligatorServeOptions.hostname", "kind": "member", "signature": "hostname?: string;", "module": "global", "url": "/api/runtime#MaligatorServeOptions.hostname", "availability": "Requires the corresponding host surface.", "description": "Bind address. Defaults to 0.0.0.0; use 127.0.0.1 for a local-only listener.", "guides": [ "/guides/assets", "/guides/http" ] }, { "name": "MaligatorServeOptions.port", "kind": "member", "signature": "port?: number;", "module": "global", "url": "/api/runtime#MaligatorServeOptions.port", "availability": "Requires the corresponding host surface.", "description": "TCP port, 0 through 65535. Defaults to 0, which asks the OS to choose a port.", "guides": [ "/guides/assets", "/guides/http" ] }, { "name": "MaligatorServeOptions.fetch", "kind": "member", "signature": "fetch(request: Request): Response | PromiseLike;", "module": "global", "url": "/api/runtime#MaligatorServeOptions.fetch", "availability": "Requires the corresponding host surface.", "description": "Handle a request with a Response or an awaited response.", "guides": [ "/guides/assets", "/guides/http" ] }, { "name": "MaligatorServeOptions.headersTimeout", "kind": "member", "signature": "headersTimeout?: number;", "module": "global", "url": "/api/runtime#MaligatorServeOptions.headersTimeout", "availability": "Requires the corresponding host surface.", "description": "Header deadline in milliseconds; 0 also selects the default. Integer 0..2147483647.\nDefault: `60000`.", "default": "60000", "guides": [ "/guides/assets", "/guides/http" ] }, { "name": "MaligatorServeOptions.requestTimeout", "kind": "member", "signature": "requestTimeout?: number;", "module": "global", "url": "/api/runtime#MaligatorServeOptions.requestTimeout", "availability": "Requires the corresponding host surface.", "description": "Request deadline in milliseconds; 0 also selects the default. Integer 0..2147483647.\nDefault: `300000`.", "default": "300000", "guides": [ "/guides/assets", "/guides/http" ] }, { "name": "MaligatorServeOptions.keepAliveTimeout", "kind": "member", "signature": "keepAliveTimeout?: number;", "module": "global", "url": "/api/runtime#MaligatorServeOptions.keepAliveTimeout", "availability": "Requires the corresponding host surface.", "description": "Idle keep-alive deadline in milliseconds; 0 also selects the default. Integer 0..2147483647.\nDefault: `5000`.", "default": "5000", "guides": [ "/guides/assets", "/guides/http" ] }, { "name": "MaligatorServeOptions.maxConnections", "kind": "member", "signature": "maxConnections?: number;", "module": "global", "url": "/api/runtime#MaligatorServeOptions.maxConnections", "availability": "Requires the corresponding host surface.", "description": "Concurrent connection limit; 0 also selects the default. Integer 0..2147483647.\nDefault: `1024`.", "default": "1024", "guides": [ "/guides/assets", "/guides/http" ] }, { "name": "MaligatorServer", "kind": "type", "signature": "export interface MaligatorServer {\n\t/** Actual bound port, including an OS-selected port when the requested port was 0. */\n\treadonly port: number;\n}", "module": "global", "url": "/api/runtime#MaligatorServer", "availability": "Requires the corresponding host surface.", "description": "", "guides": [ "/guides/assets", "/guides/http" ] }, { "name": "MaligatorServer.port", "kind": "member", "signature": "readonly port: number;", "module": "global", "url": "/api/runtime#MaligatorServer.port", "availability": "Requires the corresponding host surface.", "description": "Actual bound port, including an OS-selected port when the requested port was 0.", "guides": [ "/guides/assets", "/guides/http" ] }, { "name": "MaligatorWebRuntime", "kind": "type", "signature": "export interface MaligatorWebRuntime {\n\t/**\n\t * Start an HTTP listener. Requires surface.webPlatform. The current handle exposes\n\t * its bound port; it has no public stop method. Invalid timeout/connection limits throw.\n\t * @see https://maligator.ddv.tools/api/runtime#Mal.serve\n\t */\n\tserve(options: MaligatorServeOptions): MaligatorServer;\n}", "module": "global", "url": "/api/runtime#MaligatorWebRuntime", "availability": "Requires the corresponding host surface.", "description": "", "guides": [ "/guides/assets", "/guides/http" ] }, { "name": "Mal.serve", "kind": "member", "signature": "serve(options: MaligatorServeOptions): MaligatorServer;", "module": "global", "url": "/api/runtime#Mal.serve", "availability": "Requires the corresponding host surface.", "description": "Start an HTTP listener. Requires surface.webPlatform. The current handle exposes\nits bound port; it has no public stop method. Invalid timeout/connection limits throw.", "guides": [ "/guides/assets", "/guides/http" ] }, { "name": "mal", "kind": "export", "signature": "var mal: MaligatorRuntime;", "module": "global", "url": "/api/runtime#mal", "availability": "Requires surface.maligator.", "description": "Core namespace, available when surface.maligator is enabled.", "guides": [ "/guides/assets", "/guides/http" ] }, { "name": "Mal", "kind": "export", "signature": "var Mal: MaligatorWebRuntime;", "module": "global", "url": "/api/runtime#Mal", "availability": "Requires surface.webPlatform.", "description": "Web host namespace, available when surface.webPlatform is enabled.", "guides": [ "/guides/assets", "/guides/http" ] }, { "name": "init", "kind": "command", "module": "CLI", "signature": "init", "description": "Command and flag reference.", "url": "/api/cli#init", "availability": "CLI", "guides": [ "/guides/getting-started", "/guides/production", "/guides/development", "/guides/testing", "/guides/profiling", "/guides/troubleshooting" ] }, { "name": "doctor", "kind": "command", "module": "CLI", "signature": "doctor", "description": "Command and flag reference.", "url": "/api/cli#doctor", "availability": "CLI", "guides": [ "/guides/getting-started", "/guides/production", "/guides/development", "/guides/testing", "/guides/profiling", "/guides/troubleshooting" ] }, { "name": "build", "kind": "command", "module": "CLI", "signature": "build", "description": "Command and flag reference.", "url": "/api/cli#build", "availability": "CLI", "guides": [ "/guides/getting-started", "/guides/production", "/guides/development", "/guides/testing", "/guides/profiling", "/guides/troubleshooting" ] }, { "name": "run", "kind": "command", "module": "CLI", "signature": "run", "description": "Command and flag reference.", "url": "/api/cli#run", "availability": "CLI", "guides": [ "/guides/getting-started", "/guides/production", "/guides/development", "/guides/testing", "/guides/profiling", "/guides/troubleshooting" ] }, { "name": "dev", "kind": "command", "module": "CLI", "signature": "dev", "description": "Command and flag reference.", "url": "/api/cli#dev", "availability": "CLI", "guides": [ "/guides/getting-started", "/guides/production", "/guides/development", "/guides/testing", "/guides/profiling", "/guides/troubleshooting" ] }, { "name": "test", "kind": "command", "module": "CLI", "signature": "test", "description": "Command and flag reference.", "url": "/api/cli#test", "availability": "CLI", "guides": [ "/guides/getting-started", "/guides/production", "/guides/development", "/guides/testing", "/guides/profiling", "/guides/troubleshooting" ] }, { "name": "--profile", "kind": "command", "module": "CLI", "signature": "--profile", "description": "Command and flag reference.", "url": "/api/cli#profile", "availability": "CLI", "guides": [ "/guides/getting-started", "/guides/production", "/guides/development", "/guides/testing", "/guides/profiling", "/guides/troubleshooting" ] }, { "name": "cache", "kind": "command", "module": "CLI", "signature": "cache", "description": "Command and flag reference.", "url": "/api/cli#cache", "availability": "CLI", "guides": [ "/guides/getting-started", "/guides/production", "/guides/development", "/guides/testing", "/guides/profiling", "/guides/troubleshooting" ] }, { "name": "Diagnostic build options", "kind": "command", "module": "CLI", "signature": "Diagnostic build options", "description": "Command and flag reference.", "url": "/api/cli#diagnostic-build-options", "availability": "CLI", "guides": [ "/guides/getting-started", "/guides/production", "/guides/development", "/guides/testing", "/guides/profiling", "/guides/troubleshooting" ] }, { "name": "--compile-concurrency", "kind": "command", "module": "CLI", "signature": "--compile-concurrency", "description": "Production total job limit, integer 1..3. Default is at most 3, bounded by host CPU capacity. Profiling is serial.", "url": "/api/cli#build", "availability": "CLI", "guides": [ "/guides/getting-started", "/guides/production", "/guides/development", "/guides/testing", "/guides/profiling", "/guides/troubleshooting" ] }, { "name": "--compile-concurrency", "kind": "command", "module": "CLI", "signature": "--compile-concurrency", "description": "1. Positive integer compilation budget. ", "url": "/api/cli#test", "availability": "CLI", "guides": [ "/guides/getting-started", "/guides/production", "/guides/development", "/guides/testing", "/guides/profiling", "/guides/troubleshooting" ] } ] }