Documentation
    Preparing search index...

    Interface NapSpecRef

    Where a NAP document was read from when the mock was written.

    const ref: NapSpecRef = {
      nap: 'NAP-LINK',
      status: 'draft',
      source: 'pr',
      pr: 53,
      sha: '50a2cd45e76f',
      path: 'naps/NAP-LINK.md',
    };
    interface NapSpecRef {
        nap: string;
        path: string;
        pr?: number;
        sha: string;
        source: "master" | "pr";
        status: "merged" | "draft" | "exploratory";
    }
    Index

    Properties

    nap path pr? sha source status

    Properties

    nap: string

    Document name, e.g. NAP-RELAY.

    path: string

    Repository path of the document.

    pr?: number

    Pull request number when source is pr.

    sha: string

    Abbreviated (8+ hex) commit sha of the checked head.

    source: "master" | "pr"

    master for merged docs, pr for pull-request heads.

    status: "merged" | "draft" | "exploratory"

    merged on master, draft in an open PR, exploratory for sub-track or projection docs.

    Settings

    Member Visibility

    On This Page

    Properties