@opentdf/sdk
    Preparing search index...

    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>;
    }
    Index

    Properties

    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: () => Promise<void>

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

    decrypt: () => Promise<DecoratedStream>

    Decrypt the payload.

    manifest: () => Promise<Manifest>

    Only present on ZTDF files