Protocol API Reference

Constants

Since v4.0.0

Prefix for virtual doctest collector module requests.

declare const collectorPrefix: "virtual:effect-doctest/collector?"

Since v4.0.0

Query parameter used to identify resolved doctest modules.

declare const resolvedMarker: "effect-doctest"

Since v4.0.0

Prefix for virtual doctest snippet module requests.

declare const snippetPrefix: "virtual:effect-doctest/snippet?"

interface

Since v4.0.0

Describes a virtual doctest module request.

interface Request {
  readonly file: string;
  readonly index?: number;
  readonly version?: string;
}

Since v4.0.0

Creates a virtual doctest collector module identifier.

declare function collectorId(file: string, version?: string): string

Since v4.0.0

Parses a virtual doctest request with the specified prefix.

declare function request(prefix: string, id: string): Request | undefined

Since v4.0.0

Creates the identifier of a resolved doctest module.

declare function resolvedId(kind: "collector" | "snippet", value: Request): string

Since v4.0.0

Parses the identifier of a resolved doctest module.

declare function resolvedRequest(id: string): Request & {
  readonly kind: "collector" | "snippet";
} | undefined

Since v4.0.0

Creates a virtual doctest snippet module identifier.

declare function snippetId(file: string, index: number, version?: string): string