Documentation / @imvu/chkn / CflArchive

Class: CflArchive

Defined in: packages/chkn/src/Cfl.ts:43

A parsed CFL archive. Entries are decompressed on first access and cached.

Properties

hashed

readonly hashed: boolean;

Defined in: packages/chkn/src/Cfl.ts:49

Whether the archive is DFL3 (with content hashes).

Accessors

entries

Get Signature

get entries(): CflEntry[];

Defined in: packages/chkn/src/Cfl.ts:133

Returns

CflEntry[]

---

names

Get Signature

get names(): string[];

Defined in: packages/chkn/src/Cfl.ts:137

Returns

string[]

Methods

entry()

entry(name): CflEntry | undefined;

Defined in: packages/chkn/src/Cfl.ts:145

Parameters

Parameter	Type
name	string

Returns

CflEntry | undefined

---

files()

files(): Generator<[string, Uint8Array<ArrayBufferLike>]>;

Defined in: packages/chkn/src/Cfl.ts:167

Every entry, decompressed.

Returns

Generator<[string, Uint8Array<ArrayBufferLike>]>

---

get()

get(name): Uint8Array<ArrayBufferLike> | undefined;

Defined in: packages/chkn/src/Cfl.ts:150

An entry's contents, or undefined if the archive has no such entry.

Parameters

Parameter	Type
name	string

Returns

Uint8Array<ArrayBufferLike> | undefined

---

has()

has(name): boolean;

Defined in: packages/chkn/src/Cfl.ts:141

Parameters

Parameter	Type
name	string

Returns

boolean

---

text()

text(name): string | undefined;

Defined in: packages/chkn/src/Cfl.ts:161

An entry's contents as UTF-8 text.

Parameters

Parameter	Type
name	string

Returns

string | undefined

---

create()

static create(files): Uint8Array;

Defined in: packages/chkn/src/Cfl.ts:93

Build a CFL archive. Entries are stored uncompressed — the classic client reads that (compression 0) as readily as LZMA.

Parameters

Parameter	Type
files	| Iterable<[string, Uint8Array<ArrayBufferLike>], any, any> | Record<string, Uint8Array<ArrayBufferLike>>

Returns

Uint8Array

---

parse()

static parse(input): CflArchive;

Defined in: packages/chkn/src/Cfl.ts:85

Parse a CFL archive. The bytes are kept (not copied); entries decompress lazily.

Parameters

Parameter	Type
input	ArrayBuffer | Uint8Array<ArrayBufferLike>

Returns

CflArchive