Class ArchiveExtractor

Reads zip and gzip. A deployment needing another format subclasses Unpack at the same key.

Hierarchy (View Summary)

BaseContentExtractor
- ArchiveExtractor

Index

Constructors

Properties

Key SupportedFileTypes

Methods

Extract Supports Unpack Resolve

Constructors

constructor

new ArchiveExtractor(): ArchiveExtractor
Returns ArchiveExtractor
Inherited from BaseContentExtractor.constructor

Properties

`Readonly`Key

Key: "Archive" = ARCHIVE_EXTRACTOR

The registration key. Must match the key passed to @RegisterClass.

`Readonly`SupportedFileTypes

SupportedFileTypes: string[] = ...

The file types this extractor handles. '*' means any; only the built-in fallback should use it.

Methods

Extract

Extract(request: ExtractRequest): Promise<ExtractResult>
Read the bytes.
Parameters
- request: ExtractRequest
Returns Promise<ExtractResult>
Overrides BaseContentExtractor.Extract
- Defined in ContentPipeline/engine/src/extractors/ArchiveExtractor.ts:43

Supports

Supports(fileType: string): boolean
Whether this extractor handles a given file type.
Parameters
- fileType: string
Returns boolean
Inherited from BaseContentExtractor.Supports
- Defined in ContentPipeline/base/dist/extract/BaseContentExtractor.d.ts:94

`Protected`Unpack

Unpack(request: ExtractRequest): Promise<ArchiveMember[]>
Unpack by the file type Extract resolved from the bytes.
Parameters
- request: ExtractRequest
Returns Promise<ArchiveMember[]>
Throws
When the bytes are not a readable archive or expand past the limits, so the record fails rather than reading as an empty archive.
- Defined in ContentPipeline/engine/src/extractors/ArchiveExtractor.ts:70

`Static`Resolve

Resolve(key: string): BaseContentExtractor
Resolve a registered extractor by key, returning null rather than a hollow base instance.
Parameters
- key: string
Returns BaseContentExtractor
Inherited from BaseContentExtractor.Resolve
- Defined in ContentPipeline/base/dist/extract/BaseContentExtractor.d.ts:96