extract-files

Reversibly extracts File, Blob and ReactNativeFile instances, with object paths, from an object tree and replaces them with null. FileList instances are treated as File instance arrays.

Usage

Install with npm:

npm install extract-files

See the extractFiles documentation to get started.

Reassembly

Loop and reinsert the extracted files using object-path:

import { extractFiles } from 'extract-files'
import objectPath from 'object-path'
import tree from './tree'

const files = extractFiles(tree)
const treePath = objectPath(tree)

files.forEach(({ path, file }) => treePath.set(path, file))

FileList instances in the original tree become File instance arrays when reassembled.

Support

• Node.js v6.10+
• Browsers >1% usage
• React Native

API

Table of contents

• class ReactNativeFile
  • Examples
• function extractFiles
  • Examples
• type ExtractedFile
• type ObjectPath
  • See
  • Examples
• type ReactNativeFileSubstitute
  • See

class ReactNativeFile

Used to mark a React Native File substitute in an object tree for extractFiles. It’s too risky to assume all objects with uri, type and name properties are files to extract.

Examples

An extractable file in React Native.

import { ReactNativeFile } from 'extract-files'

const file = new ReactNativeFile({
  uri: uriFromCameraRoll,
  name: 'a.jpg',
  type: 'image/jpeg'
})

function extractFiles

Reversibly extracts File, Blob and ReactNativeFile instances, with object paths, from an object tree and replaces them with null. FileList instances are treated as File instance arrays.

Returns: Array<ExtractedFile> — Extracted files or an empty array if the tree is not an enumerable object.

Examples

Extracting files.

The following:

import { extractFiles } from 'extract-files'

console.log(
  extractFiles(
    {
      a: new File(['a'], 'a.txt', { type: 'text/plain' }),
      b: [
        {
          c: new File(['b'], 'b.txt', { type: 'text/plain' })
        }
      ]
    },
    'prefix'
  )
)

Logs:

[{
  path: 'prefix.a',
  file: [object File]
}, {
  path: 'prefix.b.0.c',
  file: [object File]
}]

type ExtractedFile

An extracted file.

Type: Object

type ObjectPath

String notation for the path to a node in an object tree.

Type: String

See

• object-path on npm.

Examples

Object path is property a, array index 0, object property b.

a.0.b

type ReactNativeFileSubstitute

A React Native File substitute for when using FormData.

Type: Object

See

• React Native FormData polyfill source.