Skip to main content

Type Alias: NSID

NSID: string & object

Defined in: src/types/atproto.ts:100

Namespaced Identifier (NSID) for Lexicon schemas.

Type declaration​

__brand​

readonly __brand: "NSID"

Remarks​

NSIDs provide globally unique identifiers for Lexicon schemas using reverse domain name notation.

Format: authority.name.subname

  • authority: Reverse domain (e.g., "pub.chive")
  • name and subname: Schema identifiers

NSIDs are used to identify:

  • Record collections (e.g., "pub.chive.preprint.submission")
  • RPC procedures (e.g., "pub.chive.search.query")
  • Event types (e.g., "pub.chive.notification.created")

Example​

const nsid = toNSID('pub.chive.preprint.submission');
if (nsid) {
  console.log('Valid NSID:', nsid);
}

See​

NSID Specification