Clones a value, recursively extracting File, Blob and ReactNativeFile instances with their object paths, replacing them with null. FileList instances are treated as File instance arrays.

Used by GraphQL multipart request spec client implementations such as graphql-react and apollo-upload-client.

Install with npm:

npm install extract-files

See the extractFiles documentation to get started.

• Node.js v6+
• Browsers > 0.5%, not dead
• React Native

• class ReactNativeFile
  • Examples
• function extractFiles
  • Examples
• type ExtractableFile
• type ExtractFilesResult
• type ObjectPath
  • See
  • Examples
• type ReactNativeFileSubstitute
  • See
  • Examples

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.

An extractable file in React Native.

import { ReactNativeFile } from 'extract-files'

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

Clones a value, recursively extracting File, Blob and ReactNativeFile instances with their object paths, replacing them with null. FileList instances are treated as File instance arrays.

Returns: ExtractFilesResult — Result.

Extract files from an object.

For the following:

import { extractFiles } from 'extract-files'

const file1 = new File(['1'], '1.txt', { type: 'text/plain' })
const file2 = new File(['2'], '2.txt', { type: 'text/plain' })
const value = {
  a: file1,
  b: [file1, file2]
}

const { clone, files } = extractFiles(value, 'prefix')

value remains the same.

clone is:

{
  a: null,
  b: [null, null]
}

files is a Map instance containing:

Key	Value
file1	['prefix.a', 'prefix.b.0']
file2	['prefix.b.1']

An extractable file.

Type: File | Blob | ReactNativeFile

What extractFiles returns.

Type: Object

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

Type: String

• object-path on npm.

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

a.0.b

A React Native File substitute for when using FormData.

Type: Object

• React Native FormData polyfill source.

A camera roll file.

{
  uri: uriFromCameraRoll,
  name: 'a.jpg',
  type: 'image/jpeg'
}