Documentation
    Preparing search index...

    Interface Nip51List

    A parsed NIP-51 list or set.

    publicItems holds the item-bearing tags verbatim. privateItems is populated only after decryptPrivateItems runs; until then it is undefined (the encrypted payload is left untouched in Nip51List.encryptedContent).

    const list = parseList(kind10000MuteEvent);
    list.kind;        // 10000
    list.type;        // 'mute'
    list.family;      // 'list'
    getTagValues(list.publicItems, 'p'); // muted pubkeys (public portion)
    interface Nip51List {
        address: string | undefined;
        description: string | undefined;
        encryptedContent: string | undefined;
        family: "list" | "set" | "unknown";
        identifier: string;
        image: string | undefined;
        kind: number;
        privateItems: string[][] | undefined;
        pubkey: string;
        publicItems: string[][];
        title: string | undefined;
        type: string | undefined;
    }
    Index

    Properties

    address description encryptedContent family identifier image kind privateItems pubkey publicItems title type

    Properties

    address: string | undefined

    Addressable coordinate kind:pubkey:d for sets; undefined for standard lists.

    description: string | undefined

    Optional description tag (sets).

    encryptedContent: string | undefined

    Raw NIP-44-encrypted content, if any (the private portion).

    family: "list" | "set" | "unknown"

    'list' for standard lists (10000–10101), 'set' for sets (30000–30030), 'unknown' otherwise.

    identifier: string

    Set identifier from the d tag (sets only; '' for standard lists / missing).

    image: string | undefined

    Optional image tag (sets).

    kind: number

    Event kind.

    privateItems: string[][] | undefined

    Decrypted private item tags — undefined until decryptPrivateItems succeeds.

    pubkey: string

    Author pubkey.

    publicItems: string[][]

    Item-bearing tags verbatim (the public portion of the list).

    title: string | undefined

    Optional title tag (sets).

    type: string | undefined

    Friendly kind name from listKindName, or undefined for unknown kinds.

    Settings

    Member Visibility

    On This Page

    Properties