@karmaniverous/stan-context
    Preparing search index...

    Type Alias GraphOptions

    type GraphOptions = {
        config?: { excludes?: string[]; includes?: string[] };
        cwd: string;
        hashSizeEnforcement?: HashSizeEnforcement;
        maxErrors?: number;
        nodeDescriptionLimit?: number;
        nodeDescriptionTags?: string[];
        previousGraph?: DependencyGraph;
        typescript?: __module;
        typescriptPath?: string;
    }
    Index

    Properties

    config? cwd hashSizeEnforcement? maxErrors? nodeDescriptionLimit? nodeDescriptionTags? previousGraph? typescript? typescriptPath?

    Properties

    config?: { excludes?: string[]; includes?: string[] }
    cwd: string
    hashSizeEnforcement?: HashSizeEnforcement

    Policy for enforcing the invariant: if metadata.hash is present for a file node, metadata.size should also be present.

    Default: 'warn'.

    maxErrors?: number

    Maximum number of GraphResult.errors entries returned. When truncated, the final entry is a deterministic sentinel. Set to 0 to omit errors.

    nodeDescriptionLimit?: number

    Maximum prefix length of GraphNode.description (TS/JS only).

    When truncated, ASCII ... is appended (not counted in the prefix limit). Set to 0 to omit descriptions.

    nodeDescriptionTags?: string[]

    Which TSDoc tags are considered when deriving descriptions (TS/JS only).

    Tags MUST include the @ prefix and match ^@\\w+$.

    Defaults to ['@module', '@packageDocumentation'].

    previousGraph?: DependencyGraph
    typescript?: __module

    Injected TypeScript module instance to use for TS/JS analysis.

    This package does not attempt to resolve TypeScript implicitly. Callers MUST provide either typescript or typescriptPath.

    typescriptPath?: string

    Absolute path to a TypeScript entry module to load (for example, the result of require.resolve('typescript') from the host environment).

    This is intended for hosts that want to control the TypeScript source deterministically (stan-cli, IDE SDK, web service, etc.).

    Settings

    Member Visibility

    On This Page

    Properties