Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/jaydenseric/extract-files

A function to recursively extract files and their object paths within a value, replacing them with null in a deep clone without mutating the original value. FileList instances are treated as File instance arrays. Files are typically File and Blob instances.
https://github.com/jaydenseric/extract-files

esm graphql maintained mjs node npm typescript

Last synced: 6 days ago
JSON representation

Host: GitHub
URL: https://github.com/jaydenseric/extract-files
Owner: jaydenseric
License: mit
Created: 2017-07-11T06:01:02.000Z (over 7 years ago)
Default Branch: master
Last Pushed: 2022-08-29T06:59:07.000Z (about 2 years ago)
Last Synced: 2024-04-14T04:37:27.211Z (7 months ago)
Topics: esm, graphql, maintained, mjs, node, npm, typescript
Language: JavaScript
Homepage: https://npm.im/extract-files
Size: 213 KB
Stars: 53
Watchers: 5
Forks: 24
Open Issues: 1
Metadata Files:
- Readme: readme.md
- Changelog: changelog.md
- Funding: .github/funding.yml
- License: license.md

Awesome Lists containing this project

README

        # extract-files

A function to recursively extract files and their object paths within a value, replacing them with `null` in a deep clone without mutating the original value. [`FileList`](https://developer.mozilla.org/en-US/docs/Web/API/Filelist) instances are treated as [`File`](https://developer.mozilla.org/en-US/docs/Web/API/File) instance arrays. Files are typically [`File`](https://developer.mozilla.org/en-US/docs/Web/API/File) and [`Blob`](https://developer.mozilla.org/en-US/docs/Web/API/Blob) instances.

Used by [GraphQL multipart request spec client implementations](https://github.com/jaydenseric/graphql-multipart-request-spec#implementations) such as [`graphql-react`](https://npm.im/graphql-react) and [`apollo-upload-client`](https://npm.im/apollo-upload-client).

## Installation

For [Node.js](https://nodejs.org), to install [`extract-files`](https://npm.im/extract-files) with [npm](https://npmjs.com/get-npm), run:

```sh

npm install extract-files

```

For [Deno](https://deno.land) and browsers, an example import map:

```json

{

  "imports": {

    "extract-files/": "https://unpkg.com/[email protected]/",

    "is-plain-obj": "https://unpkg.com/[email protected]/index.js",

    "is-plain-obj/": "https://unpkg.com/[email protected]/"

  }

}

```

See the function [`extractFiles`](./extractFiles.mjs) to get started.

## Requirements

Supported runtime environments:

- [Node.js](https://nodejs.org) versions `^14.17.0 || ^16.0.0 || >= 18.0.0`.

- [Deno](https://deno.land), importing from a CDN that might require an import map for dependencies.

- Browsers matching the [Browserslist](https://browsersl.ist) query [`> 0.5%, not OperaMini all, not dead`](https://browsersl.ist/?q=%3E+0.5%25%2C+not+OperaMini+all%2C+not+dead).

Non [Deno](https://deno.land) projects must configure [TypeScript](https://typescriptlang.org) to use types from the ECMAScript modules that have a `// @ts-check` comment:

- [`compilerOptions.allowJs`](https://typescriptlang.org/tsconfig#allowJs) should be `true`.

- [`compilerOptions.maxNodeModuleJsDepth`](https://typescriptlang.org/tsconfig#maxNodeModuleJsDepth) should be reasonably large, e.g. `10`.

- [`compilerOptions.module`](https://typescriptlang.org/tsconfig#module) should be `"node16"` or `"nodenext"`.

## Exports

The [npm](https://npmjs.com) package [`extract-files`](https://npm.im/extract-files) features [optimal JavaScript module design](https://jaydenseric.com/blog/optimal-javascript-module-design). It doesn’t have a main index module, so use deep imports from the ECMAScript modules that are exported via the [`package.json`](./package.json) field [`exports`](https://nodejs.org/api/packages.html#exports):

- [`extractFiles.mjs`](./extractFiles.mjs)

- [`isExtractableFile.mjs`](./isExtractableFile.mjs)