@ndn/packet/lib/name/convention.d.ts

NDNts: Network Layer Packets

import type { Component } from "./component.js";
/**
 * Naming convention, which interprets a name component in a specific way.
 * @typeParam A - Input type to construct component.
 * @typeParam R - Output type to interpret component.
 */
export interface NamingConvention<A, R = A> {
    /** Determine if a component follows this naming convention. */
    match: (comp: Component) => boolean;
    /** Create a component from input value following this naming convention. */
    create: (v: A) => Component;
    /** Parse value of a matched component. */
    parse: (comp: Component) => R;
}
export declare namespace NamingConvention {
    /** A naming convention that supports alternate/pretty URI. */
    interface WithAltUri {
        /** Convert to alternate URI. */
        toAltUri: (comp: Component) => string;
        /**
         * Parse from alternate URI.
         * @returns Component, or `undefined` if it cannot be parsed.
         */
        fromAltUri: (input: string) => Component | undefined;
    }
    /** Determine whether an object implements `NamingConvention` interface. */
    function isConvention(obj: any): obj is NamingConvention<any>;
}