Skip to content

An atomic library containing only a single class: FileListExt, which seeks to extend the built-in FileList class and provide tools for easier reading and manipulation of FileLists, as well as converting between File, File[], and FileList.

License

Notifications You must be signed in to change notification settings

computergnome99/file-list-ext

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

22 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

JSR NPM GitHub

file-list-ext

file-list-ext is an atomic library containing only a single class: FileListExt, which seeks to extend the built-in FileList class and provide tools for easier reading and manipulation of FileLists, as well as converting between File, File[], and FileList.

Warning

Obviously, the FileList class is read-only for a reason. Mutating or writing to a FileList can be a security risk in some cases. Please be sure that you are using this class carefully and considering the implications of your own code.

Getting Started

To get started using file-list-ext, just install the package using your preferred package manager:

Using JSR Repositories
# deno
deno add jsr:@calvinbonner/file-list-ext --dev

# npm
npx jsr add @calvinbonner/file-list-ext --dev

# pnpm
pnpm dlx jsr add @calvinbonner/file-list-ext --dev

# bun
bunx jsr add @calvinbonner/file-list-ext --dev

# yarn
yarn dlx jsr add @calvinbonner/file-list-ext --dev

Or, when using Deno, you can import directly from JSR without installing:

import * as file_list_ext from "jsr:@calvinbonner/file-list-ext";
Using NPM Repositories
# npm
npm install @calvinbonner/file-list-ext --save-dev

# pnpm
pnpm add @calvinbonner/file-list-ext --save-dev

# bun
bun add @calvinbonner/file-list-ext --dev

# yarn
yarn add @calvinbonner/file-list-ext --dev

Contributing

Please feel free to open an issue on GitHub or create a PR. When running the source locally, you can run unit tests using bun test or bun test --watch.

To-Do

The following are items on my To-Do list for this project. If you're looking to contribute, please check this list to see if what you need is already on here.

  • JSDoc Coverage
  • Unit Test Coverage
  • Update mutating methods to avoid unnecessary array duplication (mutate in-place)
  • Require formatting prior to commit/publish

About

An atomic library containing only a single class: FileListExt, which seeks to extend the built-in FileList class and provide tools for easier reading and manipulation of FileLists, as well as converting between File, File[], and FileList.

Resources

License

Stars

Watchers

Forks