summaryrefslogtreecommitdiff
path: root/node_modules/yaml/dist/doc/anchors.d.ts
blob: fac66be7e585b59866cf867da8813142888db9fb (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
import { Node } from '../nodes/Node.js';
import type { Document } from './Document.js';
/**
 * Verify that the input string is a valid anchor.
 *
 * Will throw on errors.
 */
export declare function anchorIsValid(anchor: string): true;
export declare function anchorNames(root: Document | Node): Set<string>;
/** Find a new anchor name with the given `prefix` and a one-indexed suffix. */
export declare function findNewAnchor(prefix: string, exclude: Set<string>): string;
export declare function createNodeAnchors(doc: Document, prefix: string): {
    onAnchor: (source: unknown) => string;
    /**
     * With circular references, the source node is only resolved after all
     * of its child nodes are. This is why anchors are set only after all of
     * the nodes have been created.
     */
    setAnchors: () => void;
    sourceObjects: Map<unknown, {
        anchor: string | null;
        node: Node<unknown> | null;
    }>;
};