Skip to content

Protocol

9 exports Added in v4.0.0 Source

Constants

collectorPrefix

Added in v4.0.0 Source

Prefix for virtual doctest collector module requests.

Signature

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

resolvedMarker

Added in v4.0.0 Source

Query parameter used to identify resolved doctest modules.

Signature

declare const resolvedMarker: "effect-doctest";

snippetPrefix

Added in v4.0.0 Source

Prefix for virtual doctest snippet module requests.

Signature

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

Models

Request interface

Added in v4.0.0 Source

Describes a virtual doctest module request.

Signature

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

Protocols

collectorId

Added in v4.0.0 Source

Creates a virtual doctest collector module identifier.

Signature

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

request

Added in v4.0.0 Source

Parses a virtual doctest request with the specified prefix.

Signature

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

resolvedId

Added in v4.0.0 Source

Creates the identifier of a resolved doctest module.

Signature

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

resolvedRequest

Added in v4.0.0 Source

Parses the identifier of a resolved doctest module.

Signature

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

snippetId

Added in v4.0.0 Source

Creates a virtual doctest snippet module identifier.

Signature

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