filelist-utils

filelist-utils

Create a FileCollection from various sources.

Introduction

In order to make compatible code between the browser and node and to allow drag and drop of a folder it is useful to an abstraction level.

This package allows to create a FileCollection from various sources:

• a FileList (that implements an Iterator of File).
• a relative path (with its basedir)
• a webservice that returns a JSON containing an array of object that has the following properties: relativePath, name, lastModified, size

A FileCollection has an iterator on FileCollectionItem that has the following properties:

• lastModified: number;
• name: string;
• relativePath: string;
• size: number;
• arrayBuffer(): Promise;
• stream(): ReadableStream;
• text(): Promise;

Installation

npm i filelist-utils

Usage

import { fileCollectionFromPath } from 'filelist-utils';

const fileCollection = fileCollectionFromPath(__dirname);

import { fileCollectionFromZip } from 'filelist-utils';

const zip = readFileSync(join(__dirname, 'test.zip'));
const fileCollection = fileCollectionFromZip(zip);

License

MIT

Changelog

0.10.0 (2022-09-29)

chore!: rename FileList to FileCollection chore!: rename File to FileCollectionItem chore!: rename webkitRelativePath to relativePath feat: add fileCollectionFromFileList refactor: remove baseName option and fix on Windows feat: default unzip ungzip using fromFileList and fromWebService

⚠ BREAKING CHANGES

• rename FileList to FileCollection
• rename File to FileCollectionItem
• rename webkitRelativePath to relativePath
• create internal class containing items

Features

• add fileCollectionFromFileList
• add fileCollectionFromPath
• add fileCollectionFromWebservice
• add fileCollectionFromZip

Miscellaneous Chores

• create internal class containing items (4633c4a)