Class CacheStorageNappletArtifactCache

Browser Cache Storage implementation of NappletArtifactCache.

It stores verified blobs and aggregate records under synthetic URLs, keeps a small JSON index, and prunes according to quota-derived budgets.

Implements

NappletArtifactCache

Index

Constructors

constructor

Methods

deleteBlob getCoordinate markAggregateActive prune readBlob releaseAggregateActive snapshotIndex touchAggregate writeCoordinate writeVerifiedResolution

Constructors

constructor

new CacheStorageNappletArtifactCache(
options?: CacheStorageNappletArtifactCacheOptions,
): CacheStorageNappletArtifactCache
Parameters
- options: CacheStorageNappletArtifactCacheOptions = {}
Returns CacheStorageNappletArtifactCache
- Defined in packages/nip/src/5d/artifact-cache.ts:306

Methods

deleteBlob

deleteBlob(sha256Hex: string): Promise<void>
Delete one cached artifact blob by SHA-256 hash.
Parameters
- sha256Hex: string
Returns Promise<void>
Implementation of NappletArtifactCache.deleteBlob
- Defined in packages/nip/src/5d/artifact-cache.ts:342

getCoordinate

getCoordinate(
input: { dTag: string; kind: number; pubkey: string },
options?: CoordinateFreshnessOptions,
): Promise<CachedCoordinate & { fresh: boolean } | undefined>
Read a cached coordinate with a computed freshness flag.
Parameters
- input: { dTag: string; kind: number; pubkey: string }
- options: CoordinateFreshnessOptions = {}
Returns Promise<CachedCoordinate & { fresh: boolean } | undefined>
Implementation of NappletArtifactCache.getCoordinate
- Defined in packages/nip/src/5d/artifact-cache.ts:399

markAggregateActive

markAggregateActive(dTag: string, aggregateHash: string): void
Protect an aggregate from normal pruning while it is in active use.
Parameters
- dTag: string
- aggregateHash: string
Returns void
Implementation of NappletArtifactCache.markAggregateActive
- Defined in packages/nip/src/5d/artifact-cache.ts:424

prune

prune(now?: number): Promise<void>
Prune cache contents to the configured storage budget.
Parameters
- now: number = ...
Returns Promise<void>
Implementation of NappletArtifactCache.prune
- Defined in packages/nip/src/5d/artifact-cache.ts:432

readBlob

readBlob(sha256Hex: string): Promise<Uint8Array<ArrayBufferLike> | undefined>
Read one cached artifact blob by SHA-256 hash.
Parameters
- sha256Hex: string
Returns Promise<Uint8Array<ArrayBufferLike> | undefined>
Implementation of NappletArtifactCache.readBlob
- Defined in packages/nip/src/5d/artifact-cache.ts:322

releaseAggregateActive

releaseAggregateActive(dTag: string, aggregateHash: string): void
Release an aggregate previously marked active.
Parameters
- dTag: string
- aggregateHash: string
Returns void
Implementation of NappletArtifactCache.releaseAggregateActive
- Defined in packages/nip/src/5d/artifact-cache.ts:428

snapshotIndex

snapshotIndex(): Promise<NappletArtifactCacheIndex>
Returns Promise<NappletArtifactCacheIndex>
- Defined in packages/nip/src/5d/artifact-cache.ts:498

touchAggregate

touchAggregate(dTag: string, aggregateHash: string, now?: number): Promise<void>
Update aggregate/blob last-access timestamps.
Parameters
- dTag: string
- aggregateHash: string
- now: number = ...
Returns Promise<void>
Implementation of NappletArtifactCache.touchAggregate
- Defined in packages/nip/src/5d/artifact-cache.ts:410

writeCoordinate

writeCoordinate(
    input: {
        aggregateHash: string;
        backgroundTtlMs?: number;
        dTag: string;
        foregroundTtlMs?: number;
        kind: number;
        lastResolvedAt?: number;
        pubkey: string;
    },
): Promise<void>
Cache the latest aggregate for a NIP-5D coordinate.
Parameters
- input: {
      aggregateHash: string;
      backgroundTtlMs?: number;
      dTag: string;
      foregroundTtlMs?: number;
      kind: number;
      lastResolvedAt?: number;
      pubkey: string;
  }
Returns Promise<void>
Implementation of NappletArtifactCache.writeCoordinate
- Defined in packages/nip/src/5d/artifact-cache.ts:372

writeVerifiedResolution

writeVerifiedResolution(input: WriteVerifiedResolutionInput): Promise<void>
Write a verified manifest resolution and all referenced blobs.
Parameters
- input: WriteVerifiedResolutionInput
Returns Promise<void>
Implementation of NappletArtifactCache.writeVerifiedResolution
- Defined in packages/nip/src/5d/artifact-cache.ts:355

Class CacheStorageNappletArtifactCache

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns CacheStorageNappletArtifactCache

Methods

deleteBlob

Parameters

Returns Promise<void>

getCoordinate

Parameters

Returns Promise<CachedCoordinate & { fresh: boolean } | undefined>

markAggregateActive

Parameters

Returns void

prune

Parameters

Returns Promise<void>

readBlob

Parameters

Returns Promise<Uint8Array<ArrayBufferLike> | undefined>

releaseAggregateActive

Parameters

Returns void

snapshotIndex

Returns Promise<NappletArtifactCacheIndex>

touchAggregate

Parameters

Returns Promise<void>

writeCoordinate

Parameters

Returns Promise<void>

writeVerifiedResolution

Parameters

Returns Promise<void>

Settings

On This Page