Type Alias TDFReader

A TDF reader that can decrypt and inspect a TDF file.

type TDFReader = {
    attributes: () => Promise<string[]>;
    close: () => Promise<void>;
    decrypt: () => Promise<DecoratedStream>;
    manifest: () => Promise<Manifest>;
    obligations: () => Promise<RequiredObligations>;
}

Index

Properties

attributes close decrypt manifest obligations

Properties

attributes

attributes: () => Promise<string[]>

Type declaration

- (): Promise<string[]>
- Returns Promise<string[]>
  Any data attributes found in the policy. Currently only works for plain text, embedded policies (not remote or encrypted policies)

close

close: () => Promise<void>

Mark this reader as closed and release any resources, such as open files.

decrypt

decrypt: () => Promise<DecoratedStream>

Decrypt the payload.

manifest

manifest: () => Promise<Manifest>

Only present on ZTDF files

obligations

obligations: () => Promise<RequiredObligations>

Type declaration

- (): Promise<RequiredObligations>
- Returns Promise<RequiredObligations>
  Any obligation value FQNs that are required to be fulfilled on the TDF, populated during the decrypt flow.