Interface Options

interface Options {
    cacheCleanupInterval?: number;
    cOpts?: ConsumerOptions;
    interestLifetime?: number;
    keyChain?: KeyChain;
    negativeTtl?: number;
    offline?: boolean;
    owner?: object;
    positiveTtl?: number;
    trustAnchors?: TrustAnchorContainer | Certificate[];
}

Hierarchy (View Summary)

Properties

cacheCleanupInterval? cOpts? interestLifetime? keyChain? negativeTtl? offline? owner? positiveTtl? trustAnchors?

Properties

OptionalcacheCleanupInterval

cacheCleanupInterval?: number

Cache cleanup interval, in milliseconds.

Default Value

5 minutes

Remarks

This determines how often expired cache entries are deleted.

OptionalcOpts

cOpts?: ConsumerOptions

Consumer options.

Remarks

  • .describe defaults to "CertFetcher".

OptionalinterestLifetime

interestLifetime?: number

InterestLifetime for certificate retrieval.

Remarks

If specified, .cOpts.modifyInterest is overridden.

OptionalkeyChain

keyChain?: KeyChain

Local KeyChain.

OptionalnegativeTtl

negativeTtl?: number

Cache lifetime for unsuccessful retrieval, in milliseconds.

Default Value

10 seconds

Remarks

During this period, report the certificate as un-retrievable instead of re-fetching.

Optionaloffline

offline?: boolean

If true, disable CertFetcher.

Optionalowner

owner?: object

Cache instance owner as WeakMap key.

Default Value

.cOpts.fw ?? Forwarder.getDefault()

Remarks

CertFetchers with the same .owner share the same cache instance. Cache options are determined when it's first created.

OptionalpositiveTtl

positiveTtl?: number

Cache lifetime for successful retrieval, in milliseconds.

Default Value

1 hour

Remarks

During this period, return the same certificate instead of re-fetching.

OptionaltrustAnchors

trustAnchors?: TrustAnchorContainer | Certificate[]

Trust anchor certificates.

Settings

Member Visibility

On This Page

Properties