Preparing search index...
The search index is not available
NDNts
NDNts
@ndn/autoconfig
connectToRouter
Function connectToRouter
connect
To
Router
(
router
,
opts
?
)
:
Promise
<
ConnectRouterResult
>
Connect to a router and test the connection.
Parameters
router
:
string
opts
:
ConnectRouterOptions
= {}
Returns
Promise
<
ConnectRouterResult
>
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
OS
Light
Dark
NDNts
@ndn/autoconfig
Fch
Response
Router
Connect
Network
Options
Connect
Router
Options
Connect
Router
Result
Fch
Request
Fch
Response
connect
To
Network
connect
To
Router
fch
Query
@ndn/cat
COMMAND
@ndn/cli-
common
open
Uplinks
Options
exit
Closers
close
Uplinks
exit
Handler
get
Signer
open
Key
Chain
open
Uplinks
wtf
@ndn/dpdkmgmt
Memif
Transport
Options
connect
create
Face
open
Face
Memif
Options
Options
Memif
Transport
Ndndpdk
Prefix
Reg
open
Face
@ndn/endpoint
Data
Store
Buffer
Options
Endpoint
Route
Announcement
delete
Default
Forwarder
Data
Store
Buffer
Endpoint
Consumer
Context
Consumer
Options
Data
Buffer
Options
Producer
Producer
Options
Retx
Options
Producer
Handler
Retx
Policy
@ndn/fw
Forwarder
Options
Default
Options
create
delete
Default
get
Default
replace
Default
Fw
Face
Attributes
Rx
Tx
Rx
Tx
Base
Rx
Tx
Duplex
Route
Announcement
Rx
Tx
Events
Fw
Packet
create
is
Encodable
Fw
Tracer
Options
Output
Readvertise
Destination
Status
Record
Retry
Options
Reject
Interest
Reason
Tap
Face
create
Cancel
Interest
Fw
Tracer
Readvertise
Destination
Reject
Interest
Tap
Face
Forwarder
Fw
Face
Fw
Packet
@ndn/keychain
AESCBC
Gen
Params
AESCTR
Info
Gen
Params
AESGCM
Gen
Params
Aes
Key
Length
Choices
Default
Cert
Naming
Cert
Name
Fields
Key
Name
Fields
ISSUER_
DEFAULT
ISSUER_
SELF
KEY
is
Cert
Name
is
Key
Name
make
Cert
Name
make
Key
Name
parse
Cert
Name
parse
Key
Name
to
Key
Name
to
Subject
Name
Certificate
Build
Options
Issue
Options
Self
Sign
Options
build
issue
self
Sign
Counter
Iv
Checker
Options
Counter
Iv
Gen
Options
Crypto
Algorithm
Generated
Key
Pair
Generated
Secret
Key
Private
Key
Public
Key
Secret
Key
Private
Secret
Key
Public
Secret
Key
is
Asym
is
Encryption
is
Signing
is
Sym
ECDSA
Gen
Params
Info
Ec
Curve
Choices
Default
Ed25519
Gen
Params
HMAC
Gen
Params
Key
Chain
Get
Signer
Options
Key
Pair
create
Temp
open
Key
Kind
Private
Secret
Public
Secret
Key
Store
Key
Pair
Loader
Stored
Key
Named
Decrypter
Private
Key
Secret
Key
Named
Encrypter
Public
Key
Secret
Key
Named
Signer
Private
Key
Secret
Key
Named
Verifier
Public
Key
Secret
Key
RSA
Gen
Params
Rsa
Modulus
Length
Choices
Default
Validity
Period
Timestamp
Input
MAX
days
From
Now
get
set
create
Encrypter
Import
Cert
Options
create
Verifier
Import
Cert
Options
Cert
Store
Certificate
Counter
Iv
Checker
Counter
Iv
Gen
Iv
Checker
Iv
Gen
Key
Chain
Key
Store
Random
Iv
Gen
Validity
Period
Aes
Encryption
Counter
Iv
Options
Crypto
Algorithm
Encryption
Algorithm
Named
Decrypter
Named
Encrypter
Named
Signer
Named
Verifier
Signing
Algorithm
Aes
Key
Length
Ec
Curve
Key
Kind
Private
Key
Public
Key
Rsa
Modulus
Length
Secret
Key
AESCBC
AESCTR
AESGCM
Aes
Block
Size
Crypto
Algorithm
List
Full
Crypto
Algorithm
List
Slim
ECDSA
Ed25519
Encryption
Algorithm
List
Full
Encryption
Algorithm
List
Slim
HMAC
Key
Kind
RSA
RSAOAEP
Signing
Algorithm
List
Full
Signing
Algorithm
List
Slim
create
Decrypter
create
Encrypter
create
Signer
create
Verifier
generate
Encryption
Key
generate
Signing
Key
@ndn/keychain-
cli
COMMAND
@ndn/l3face
L3
Face
State
Attributes
Create
Face
Options
Create
Face
Func
Rx
Error
Tx
Error
make
Create
Face
process
Add
Routes
Transport
Reopen
Not
Supported
Error
Attributes
Rx
Tx
L3
Face
Stream
Transport
Transport
rx
From
Packet
Iterable
rx
From
Stream
tx
To
Stream
@ndn/lp
Lp
Service
Rx
Error
Tx
Error
Options
Packet
Transport
Fragmenter
Lp
Packet
Lp
Service
Reassembler
TT
@ndn/nac
Access
Manager
Data
Store
Kek
Handle
Keys
Options
Consumer
Options
Content
Key
Fields
Locator
Parts
Name
Parts
Options
build
make
Locator
make
Name
parse
Locator
parse
Name
Key
Decryption
Key
Fields
Name
Parts
Options
build
make
Name
parse
Name
Key
Encryption
Key
Name
Parts
Options
build
make
Name
make
Subject
Name
parse
Name
Producer
Data
Store
Options
Access
Manager
Consumer
Content
Key
Encrypted
Content
Key
Decryption
Key
Key
Encryption
Key
Producer
@ndn/naming-
convention1
Byte
Offset
Segment
Sequence
Num
Timestamp
Version
@ndn/naming-
convention2
Alt
Uri
Alt
Uri2
Alt
Uri3
Byte
Offset
Byte
Offset2
Byte
Offset3
Generic
Number
Keyword
Segment
Segment2
Segment3
Sequence
Num
Sequence
Num2
Sequence
Num3
Timestamp
Timestamp2
Timestamp3
Version
Version2
Version3
ndn
distill
@ndn/ndncert
Ca
Profile
Fields
ToJSON
Options
build
Challenge
Request
Context
Fields
Options
build
Challenge
Response
Fields
Options
build
Client
Conf
Ca
Profile
Client
Email
Inbox
Imap
Extract
Options
create
Ethereal
Client
Pin
Like
Challenge
Prompt
Error
Msg
from
Data
make
Data
throw
On
Error
New
Request
Context
Fields
Options
build
New
Response
Fields
Options
build
Probe
Request
Context
Fields
Options
build
Probe
Response
Entry
Fields
Redirect
Options
build
check
Ca
Cert
Full
Name
is
Ca
Cert
Full
Name
Server
Email
Challenge
Options
Assignment
Policy
Template
Server
Options
Probe
Handler
Server
Pin
Like
Challenge
State
Server
Possession
Challenge
Assignment
Policy
Status
MAX
MIN
crypto
Session
Key
check
Request
Id
check
Salt
export
Ecdh
Pub
generate
Ecdh
Key
import
Ecdh
Pub
make
Request
Id
make
Salt
make
Session
Key
make
Signed
Interest
Policy
Error
Code
Status
Ca
Profile
Challenge
Request
Challenge
Response
Client
Email
Challenge
Client
Email
Inbox
Imap
Client
Nop
Challenge
Client
Pin
Challenge
Client
Pin
Like
Challenge
Client
Possession
Challenge
New
Request
New
Response
Probe
Request
Probe
Response
Server
Server
Email
Challenge
Server
Nop
Challenge
Server
Pin
Challenge
Server
Pin
Like
Challenge
Server
Possession
Challenge
Client
Challenge
Client
Challenge
Context
Client
Challenge
Start
Context
Client
Conf
Client
Options
Client
Probe
Options
Error
Msg
Retrieve
Ca
Profile
Options
Server
Challenge
Server
Challenge
Context
Server
Challenge
Response
Server
Options
ParameterKV
C
TT
export
Client
Conf
import
Client
Conf
match
Probe
request
Certificate
request
Probe
retrieve
Ca
Profile
@ndn/ndnsec
Ndnsec
Key
Chain
Options
Safe
Bag
Import
Options
Ndnsec
Key
Chain
Safe
Bag
@ndn/nfdmgmt
Control
Command
Options
localhop
Prefix
localhost
Prefix
call
get
Prefix
Control
Parameters
Fields
sign
Interest02
Options
Control
Parameters
Control
Response
enable
Nfd
Prefix
Reg
sign
Interest02
@ndn/node-
transport
Tcp
Transport
Options
Net
Connect
Opts
connect
create
Face
Udp
Transport
connect
create
Face
create
Multicast
Face
create
Multicast
Faces
multicast
multicasts
Unix
Transport
connect
create
Face
udp_
helper
Address
Family
Option
Connect
Options
Multicast
Options
Open
Socket
Options
Socket
Buffer
Option
Unicast
Options
Address
Family
Socket
DEFAULT_
MTU
connect
intf
Has
Address
Family
list
Multicast
Intfs
open
Multicast
Rx
open
Multicast
Tx
open
Socket
open
Unicast
Tcp
Transport
Udp
Transport
Unix
Transport
join
Host
Port
split
Host
Port
@ndn/packet
Component
Compare
Result
Data
Ctor
Arg
Final
Block
Content
Type
Freshness
Period
Interest
Ctor
Arg
Modify
Modify
Fields
Modify
Func
Can
Be
Prefix
Default
Lifetime
Must
Be
Fresh
Hop
Limit
Lifetime
Nonce
generate
Nonce
make
Modify
Func
Key
Locator
Ctor
Arg
is
Ctor
Arg
must
Get
Name
LLDecrypt
Key
Params
Result
LLEncrypt
Key
Params
Result
LLSign
Signable
OP
LLVerify
Verifiable
OP
Name
Compare
Result
from
is
Name
Like
Naming
Convention
With
Alt
Uri
is
Convention
Sig
Info
Ctor
Arg
Nonce
Seq
Num
Time
generate
Nonce
register
Extension
unregister
Extension
Signed
Interest
Policy
Nonce
Options
Options
Seq
Num
Options
Time
Options
Wrap
Options
Nonce
Seq
Num
Time
Signer
Signable
put
Sig
Info
Verifier
Verifiable
check
Sig
Type
throw
On
Bad
Sig
Alt
Uri
Converter
Component
Data
Fw
Hint
Interest
Key
Locator
Nack
Nack
Header
Name
Name
Map
Name
Multi
Map
Name
Multi
Set
Sig
Info
Signed
Interest
Policy
Decrypter
Encrypter
Naming
Convention
Signer
Verifier
Component
Like
LLDecrypt
LLEncrypt
LLSign
LLVerify
Name
Like
Alt
Uri
Implicit
Digest
Nack
Reason
Params
Digest
Sig
Type
TT
digest
Signing
noop
Encryption
noop
Signing
null
Signer
lpm
@ndn/quic-
transport
H3
Transport
connect
create
Face
H3
Transport
@ndn/rdr
Metadata
Constructor
extend
make
Metadata
Packet
Options
retrieve
Metadata
Options
serve
Metadata
Options
Metadata
Metadata
Keyword
is
Discovery
Interest
make
Discovery
Interest
make
Metadata
Packet
retrieve
Metadata
serve
Metadata
@ndn/repo
Prefix
Reg
Strip
Component
Predicate
strip
Non
Generic
Repo
Producer
Options
Fallback
Handler
Bulk
Insert
Initiator
Bulk
Insert
Target
Data
Store
Repo
Producer
Transaction
Prefix
Reg
Controller
Prefix
Reg
Dynamic
Prefix
Reg
Shorter
Prefix
Reg
Static
Prefix
Reg
Strip
respond
Rdr
@ndn/repo-
api
Data
Store
Insert
Parsed
Args
Args
parse
Args
Close
Delete
Find
Get
Insert
List
Data
List
Names
Data
Tape
Open
Stream
Stream
Mode
respond
Rdr
Options
Bulk
Insert
Initiator
Bulk
Insert
Target
Data
Tape
Copy
Options
copy
respond
Rdr
@ndn/repo-
cli
COMMAND
@ndn/repo-
external
Prps
Publisher
Options
Publication
Callback
Prps
Subscriber
Options
Subscription
Py
Repo
Client
Options
Py
Repo
Store
Options
Store
Options
Prps
Publisher
Prps
Subscriber
Py
Repo
Client
Py
Repo
Store
@ndn/segmented-
object
Data
Producer
Options
create
list
Data
Rtt
Estimator
Options
Tcp
Cubic
Options
discover
Version
Options
Result
ANY_
SUFFIX_
LEN
fetch
Result
Options
Blob
Chunk
Source
Buffer
Chunk
Source
Congestion
Avoidance
Data
Producer
File
Chunk
Source
Iterable
Chunk
Source
Rtt
Estimator
Tcp
Cubic
Chunk
Chunk
Source
Server
Chunk
Options
Serve
Options
Serve
Versioned
Options
Stream
Chunk
Source
discover
Version
fetch
make
Chunk
Source
serve
serve
Versioned
@ndn/sync
IBLT
Prepared
Parameters
Diff
Parameters
Hash
Function
PSync
Full
Options
Parameters
PSync
Partial
Publisher
Options
Parameters
PSync
Partial
Subscriber
Options
Parameters
Topic
Info
Subscription
Events
Sv
Publisher
Options
Data
Store
Sv
Subscriber
Options
Update
Subscribe
Info
Sv
Sync
Options
Timer
Sync
Protocol
Events
Syncps
Pubsub
Filter
Pub
Item
Options
Parameters
Filter
Pubs
Callback
Is
Expired
Callback
Modify
Publication
Callback
Publish
Callback
makePSync
Compat
Param
Options
make
Syncps
Compat
Param
Options
IBLT
PSync
Full
PSync
Partial
Publisher
PSync
Partial
Subscriber
Sv
Publisher
Sv
Subscriber
Sv
Sync
Sync
Update
Syncps
Pubsub
Subscriber
Subscription
Sync
Node
Sync
Protocol
PSync
Zlib
makePSync
Compat
Param
make
Syncps
Compat
Param
@ndn/tlv
Decoder
Tlv
Encoder
Omit
Empty
encode
extract
Ev
Decoder
Rule
Options
Element
Decoder
Is
Critical
Tlv
Observer
Unknown
Element
Handler
Extensible
TAG
clone
Record
Extension
clear
get
set
NNI
constrain
decode
is
Valid
Length
Decoder
Encoder
Ev
Decoder
Extension
Registry
Decodable
Encodable
Obj
Extensible
Extension
Encodable
Encodable
Tlv
NNI
printTT
@ndn/trust-
schema
versec2021
Cert
Fetcher
Options
Cert
Sources
Options
Trust
Schema
Policy
Match
Match
Input
Trust
Schema
Signer
Options
Trust
Schema
Verifier
Options
pattern
Variable
Pattern
Convention
Filter
Filter
Options
Vars
consistent
Vars
Like
to
Iterable
Alternate
Pattern
Cert
Name
Pattern
Concat
Pattern
Const
Pattern
Pattern
Variable
Pattern
Vars
Vars
Like
versec
nest
ast
Alt
Call
Component
Constraint
Component
Constraint
Eq
Component
Constraint
Rel
Component
Constraint
Term
Component
Lit
Constrained
Expr
Ident
Name
Node
Schema
Signing
Constraint
Stmt
parse
filter
Brace
Paren
Unit
scan
split
to
Tokens
un
Paren
token
Position
With
Position
UNKNOWN
from
Component
Lit
Ident
Operator
Position
Token
And
ArrowL
BraceL
BraceR
Colon
Comma
Or
ParenL
ParenR
Slash
print
scan
compile
load
print
Cert
Fetcher
Cert
Sources
Hierarchical
Verifier
Key
Chain
Cert
Source
Trust
Anchor
Container
Trust
Schema
Trust
Schema
Policy
Trust
Schema
Signer
Trust
Schema
Verifier
Cert
Source
printESM
@ndn/util
from
Hex
TABLE
to
Hex
TABLE
Closers
Key
Map
Key
Multi
Map
Key
Multi
Set
Multi
Map
Closer
console
crypto
as
Data
View
as
Uint8
Array
concat
Buffers
delay
flat
Map
Once
from
Hex
from
Utf8
random
Jitter
safe
Iter
sha256
timeout
Abort
Signal
timing
Safe
Equal
to
Hex
to
Utf8
@ndn/web-
bluetooth-
transport
Web
Bluetooth
Transport
create
Face
Web
Bluetooth
Transport
@ndn/ws-
transport
Ws
Transport
Options
connect
create
Face
Ws
Transport
Generated using
TypeDoc
Connect to a router and test the connection.