https://github.com/cheminfo/filelist-utils
Science Score: 36.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
○DOI references
-
○Academic publication links
-
✓Committers with academic emails
1 of 7 committers (14.3%) from academic institutions -
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (12.6%) to scientific vocabulary
Keywords
Keywords from Contributors
Repository
Basic Info
- Host: GitHub
- Owner: cheminfo
- License: mit
- Language: TypeScript
- Default Branch: main
- Homepage: https://cheminfo.github.io/filelist-utils/
- Size: 651 KB
Statistics
- Stars: 0
- Watchers: 5
- Forks: 1
- Open Issues: 5
- Releases: 41
Topics
Metadata Files
README.md
filelist-utils
Create a FileCollection from various sources.
DEPRECATED
This project was deprecated because it tries to modify a native type (File) which is not optimal.
A new project was created to avoid this issue and can be found at: https://www.npmjs.com/package/file-collection
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
;
Load and Save from remote server
// You should have a webservice that returns this kind of object
js
const source = {
files: [
{
name: 'data.zip',
size: 1589,
relativePath: 'dataUnzip/data.zip',
lastModified: 1664430693588,
},
{
name: 'a.txt',
size: 1,
relativePath: 'dataUnzip/dir1/a.txt',
lastModified: 1664430693588,
},
],
baseURL: 'http://localhost/',
};
const fileCollection = fileCollectionFromSource(source);
Installation
npm i filelist-utils
Usage
```js import { fileCollectionFromPath } from 'filelist-utils';
const fileCollection = fileCollectionFromPath(__dirname); ```
```js import { fileCollectionFromZip } from 'filelist-utils';
const zip = readFileSync(join(__dirname, 'test.zip')); const fileCollection = fileCollectionFromZip(zip); ```
License
Owner
- Name: Cheminfo
- Login: cheminfo
- Kind: organization
- Website: https://www.cheminfo.org/
- Repositories: 242
- Profile: https://github.com/cheminfo
GitHub Events
Total
- Create event: 2
- Issues event: 2
- Release event: 1
- Watch event: 1
- Delete event: 2
- Issue comment event: 5
- Push event: 2
- Pull request event: 3
- Pull request review event: 1
Last Year
- Create event: 2
- Issues event: 2
- Release event: 1
- Watch event: 1
- Delete event: 2
- Issue comment event: 5
- Push event: 2
- Pull request event: 3
- Pull request review event: 1
Committers
Last synced: about 1 year ago
Top Committers
| Name | Commits | |
|---|---|---|
| Luc Patiny | l****c@p****m | 89 |
| cheminfo-bot | 1****t | 41 |
| Jose Alejandro Bolanos Arroyave | j****s@c****o | 7 |
| Michaël Zasso | t****s@p****m | 4 |
| Santiago Miranda | s****r@p****m | 3 |
| hamed-musallam | 3****m | 1 |
| Santiago Miranda | s****r@p****e | 1 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 10 months ago
All Time
- Total issues: 22
- Total pull requests: 76
- Average time to close issues: 5 months
- Average time to close pull requests: 4 days
- Total issue authors: 4
- Total pull request authors: 6
- Average comments per issue: 1.41
- Average comments per pull request: 1.32
- Merged pull requests: 68
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 0
- Pull requests: 5
- Average time to close issues: N/A
- Average time to close pull requests: 39 minutes
- Issue authors: 0
- Pull request authors: 2
- Average comments per issue: 0
- Average comments per pull request: 1.6
- Merged pull requests: 5
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- lpatiny (17)
- jobo322 (2)
- targos (2)
- santimirandarp (1)
Pull Request Authors
- cheminfo-bot (46)
- lpatiny (14)
- santimirandarp (10)
- jobo322 (6)
- targos (2)
- hamed-musallam (1)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 1
-
Total downloads:
- npm 4,650 last-month
- Total dependent packages: 15
- Total dependent repositories: 16
- Total versions: 42
- Total maintainers: 2
npmjs.org: filelist-utils
Create a FileCollection from a path or a zip file
- Homepage: https://github.com/cheminfo/filelist-utils#readme
- License: MIT
- Status: deprecated
-
Latest release: 1.11.3
published over 1 year ago
Rankings
Maintainers (2)
Dependencies
- @babel/plugin-transform-modules-commonjs ^7.18.6 development
- @babel/preset-typescript ^7.18.6 development
- @types/jest ^29.0.0 development
- @types/pako ^2.0.0 development
- eslint ^8.23.0 development
- eslint-config-cheminfo-typescript ^11.0.1 development
- jest ^29.0.1 development
- msw ^0.47.3 development
- prettier ^2.7.1 development
- rimraf ^3.0.2 development
- typescript ^4.8.2 development
- cross-fetch ^3.1.5
- jszip ^3.10.1
- pako ^2.0.4
- actions/checkout v3 composite
- actions/setup-node v3 composite
- zakodium/lactame-action v1 composite
- JamesIves/github-pages-deploy-action releases/v4 composite
- actions/checkout v3 composite
- actions/setup-node v3 composite
- zakodium/typedoc-action v2 composite