Options
All
  • Public
  • Public/Protected
  • All
Menu

Module naming-convention2

@ndn/naming-convention2

This package is part of NDNts, Named Data Networking libraries for the modern web.

This package implements NDN naming conventions based on typed components.

The current format, sometimes known as rev3 format, is specified in NDN-TR-0022 revision 3 and Name Component Type Assignment rev28, published in 2021. It is supported in most other libraries and recommended for new applications.

import { Keyword, Version, Segment, AltUri } from "@ndn/naming-convention2";
// We also have ByteOffset, Timestamp, SequenceNum.

// other imports for examples
import { Name } from "@ndn/packet";
import { strict as assert } from "node:assert";

// convention.create() returns a Component.
let name = new Name(["A", Keyword.create("metadata")]);
assert.equal(name.toString(), "/8=A/32=metadata");

// name.append() has an overload for convention component.
name = name.append(Version, 3);
assert.equal(name.toString(), "/8=A/32=metadata/54=%03");
name = name.append(Segment, 0);
assert.equal(name.toString(), "/8=A/32=metadata/54=%03/50=%00");

// convention.match() checks whether a Component follows the convention.
assert.equal(Segment.match(name.at(-1)), true);
assert.equal(Version.match(name.at(-1)), false);

// Or you can use component.is().
assert.equal(name.at(-1).is(Segment), true);
assert.equal(name.at(-1).is(Version), false);

// convention.parse() extracts the value from a Component.
assert.equal(Keyword.parse(name.at(-3)), "metadata");
assert.equal(Version.parse(name.at(-2)), 3);
assert.equal(Segment.parse(name.at(-1)), 0);

// Or you can use component.as().
assert.equal(name.at(-3).as(Keyword), "metadata");
assert.equal(name.at(-2).as(Version), 3);
assert.equal(name.at(-1).as(Segment), 0);

// If you need alternate URI syntax, use AltUri.ofName() or AltUri.ofComponent().
// Make sure you are importing AltUri from this package, not from @ndn/packet package.
assert.equal(AltUri.ofName(name), "/A/32=metadata/v=3/seg=0");
assert.equal(AltUri.ofComponent(name.at(2)), "v=3");
// This feature is not in the regular component.toString() and name.toString() methods,
// because not every application would adopt this particular set of naming conventions.
// It is incorrect to interpret "54=%03" as "version 3" everywhere, because in some applications
// it could mean something completely different.
// Using AltUri from this package indicates you have adopted these naming conventions.

// Use AltUri.parseName() and AltUri.parseComponent() to parse from alternate URI syntax.
assert(AltUri.parseName("/A/32=metadata/v=3/seg=0").equals(name));
assert(AltUri.parseComponent("v=3").equals(name.at(2)));

This package also implements rev2 format, as specified in NDN-TR-0022 revision 2 and Name Component Type Assignment rev17, published in 2019. Import Segment2, ByteOffset2, Version2, Timestamp2, SequenceNum2, AltUri2 to access this format. You should not use this outdated and obsolete format in new applications, except for accessing old data.

Index

Variables

AltUri: AltUriConverter = AltUri3

Print conventions (default format, currently rev3) in alternate URI syntax.

AltUri2: AltUriConverter = ...

Print conventions (rev2) in alternate URI syntax.

AltUri3: AltUriConverter = ...

Print conventions (rev3) in alternate URI syntax.

ByteOffset: NumberBigConvention<never> = ByteOffset3

ByteOffsetNameComponent (default format, currently rev3).

ByteOffset2: NumberBigConvention = ...

ByteOffsetNameComponent (rev2), interpreted as number.

ByteOffset3: NumberBigConvention = ...

ByteOffsetNameComponent (rev3), interpreted as number.

Keyword: NamingConvention<string> = ...

KeywordNameComponent (rev2 & rev3), interpreted as string.

Segment: NumberBigConvention<never> = Segment3

SegmentNameComponent (default format, currently rev3).

Segment2: NumberBigConvention = ...

SegmentNameComponent (rev2), interpreted as number.

Segment3: NumberBigConvention = ...

SegmentNameComponent (rev3), interpreted as number.

SequenceNum: NumberBigConvention<never> = SequenceNum3

SequenceNumNameComponent (default format, currently rev3).

SequenceNum2: NumberBigConvention = ...

SequenceNumNameComponent (rev2), interpreted as number.

SequenceNum3: NumberBigConvention = ...

SequenceNumNameComponent (rev3), interpreted as number.

Timestamp: TimestampConvention = Timestamp3

TimestampNameComponent (default format, currently rev3).

Timestamp2: TimestampConvention = ...

TimestampNameComponent (rev2), interpreted as number in milliseconds.

Timestamp3: TimestampConvention = ...

TimestampNameComponent (rev3), interpreted as number in milliseconds.

Version: NumberBigConvention<never> = Version3

VersionNameComponent (default format, currently rev3).

Version2: NumberBigConvention = ...

VersionNameComponent (rev2), interpreted as number.

Version3: NumberBigConvention = ...

VersionNameComponent (rev3), interpreted as number.

Generated using TypeDoc