Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
2acec9c0dc | ||
|
|
20ee08f33e |
@@ -87,6 +87,34 @@ console.log(blob.size) // ~4 GiB
|
|||||||
|
|
||||||
`blobFrom|blobFromSync|fileFrom|fileFromSync(path, [mimetype])`
|
`blobFrom|blobFromSync|fileFrom|fileFromSync(path, [mimetype])`
|
||||||
|
|
||||||
|
### Creating a temporary file on the disk
|
||||||
|
(requires [FinalizationRegistry] - node v14.6)
|
||||||
|
|
||||||
|
When using both `createTemporaryBlob` and `createTemporaryFile`
|
||||||
|
then you will write data to the temporary folder in their respective OS.
|
||||||
|
The arguments can be anything that [fsPromises.writeFile] supports. NodeJS
|
||||||
|
v14.17.0+ also supports writing (async)Iterable streams and passing in a
|
||||||
|
AbortSignal, so both NodeJS stream and whatwg streams are supported. When the
|
||||||
|
file have been written it will return a Blob/File handle with a references to
|
||||||
|
this temporary location on the disk. When you no longer have a references to
|
||||||
|
this Blob/File anymore and it have been GC then it will automatically be deleted.
|
||||||
|
|
||||||
|
This files are also unlinked upon exiting the process.
|
||||||
|
```js
|
||||||
|
import { createTemporaryBlob, createTemporaryFile } from 'fetch-blob/from.js'
|
||||||
|
|
||||||
|
const req = new Request('https://httpbin.org/image/png')
|
||||||
|
const res = await fetch(req)
|
||||||
|
const type = res.headers.get('content-type')
|
||||||
|
const signal = req.signal
|
||||||
|
let blob = await createTemporaryBlob(res.body, { type, signal })
|
||||||
|
// const file = createTemporaryBlob(res.body, 'img.png', { type, signal })
|
||||||
|
blob = undefined // loosing references will delete the file from disk
|
||||||
|
```
|
||||||
|
|
||||||
|
`createTemporaryBlob(data, { type, signal })`
|
||||||
|
`createTemporaryFile(data, FileName, { type, signal, lastModified })`
|
||||||
|
|
||||||
### Creating Blobs backed up by other async sources
|
### Creating Blobs backed up by other async sources
|
||||||
Our Blob & File class are more generic then any other polyfills in the way that it can accept any blob look-a-like item
|
Our Blob & File class are more generic then any other polyfills in the way that it can accept any blob look-a-like item
|
||||||
An example of this is that our blob implementation can be constructed with parts coming from [BlobDataItem](https://github.com/node-fetch/fetch-blob/blob/8ef89adad40d255a3bbd55cf38b88597c1cd5480/from.js#L32) (aka a filepath) or from [buffer.Blob](https://nodejs.org/api/buffer.html#buffer_new_buffer_blob_sources_options), It dose not have to implement all the methods - just enough that it can be read/understood by our Blob implementation. The minium requirements is that it has `Symbol.toStringTag`, `size`, `slice()` and either a `stream()` or a `arrayBuffer()` method. If you then wrap it in our Blob or File `new Blob([blobDataItem])` then you get all of the other methods that should be implemented in a blob or file
|
An example of this is that our blob implementation can be constructed with parts coming from [BlobDataItem](https://github.com/node-fetch/fetch-blob/blob/8ef89adad40d255a3bbd55cf38b88597c1cd5480/from.js#L32) (aka a filepath) or from [buffer.Blob](https://nodejs.org/api/buffer.html#buffer_new_buffer_blob_sources_options), It dose not have to implement all the methods - just enough that it can be read/understood by our Blob implementation. The minium requirements is that it has `Symbol.toStringTag`, `size`, `slice()` and either a `stream()` or a `arrayBuffer()` method. If you then wrap it in our Blob or File `new Blob([blobDataItem])` then you get all of the other methods that should be implemented in a blob or file
|
||||||
@@ -104,3 +132,5 @@ See the [MDN documentation](https://developer.mozilla.org/en-US/docs/Web/API/Blo
|
|||||||
[install-size-image]: https://flat.badgen.net/packagephobia/install/fetch-blob
|
[install-size-image]: https://flat.badgen.net/packagephobia/install/fetch-blob
|
||||||
[install-size-url]: https://packagephobia.now.sh/result?p=fetch-blob
|
[install-size-url]: https://packagephobia.now.sh/result?p=fetch-blob
|
||||||
[fs-blobs]: https://github.com/nodejs/node/issues/37340
|
[fs-blobs]: https://github.com/nodejs/node/issues/37340
|
||||||
|
[fsPromises.writeFile]: https://nodejs.org/dist/latest-v18.x/docs/api/fs.html#fspromiseswritefilefile-data-options
|
||||||
|
[FinalizationRegistry]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/FinalizationRegistry
|
||||||
@@ -1,11 +1,20 @@
|
|||||||
import { statSync, createReadStream, promises as fs } from 'node:fs'
|
import {
|
||||||
import { basename } from 'node:path'
|
realpathSync,
|
||||||
|
statSync,
|
||||||
|
rmdirSync,
|
||||||
|
createReadStream,
|
||||||
|
promises as fs
|
||||||
|
} from 'node:fs'
|
||||||
|
import { basename, sep, join } from 'node:path'
|
||||||
|
import { tmpdir } from 'node:os'
|
||||||
|
import process from 'node:process'
|
||||||
import DOMException from 'node-domexception'
|
import DOMException from 'node-domexception'
|
||||||
|
|
||||||
import File from './file.js'
|
import File from './file.js'
|
||||||
import Blob from './index.js'
|
import Blob from './index.js'
|
||||||
|
|
||||||
const { stat } = fs
|
const { stat, mkdtemp } = fs
|
||||||
|
let i = 0, tempDir, registry
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @param {string} path filepath on the disk
|
* @param {string} path filepath on the disk
|
||||||
@@ -49,6 +58,42 @@ const fromFile = (stat, path, type = '') => new File([new BlobDataItem({
|
|||||||
start: 0
|
start: 0
|
||||||
})], basename(path), { type, lastModified: stat.mtimeMs })
|
})], basename(path), { type, lastModified: stat.mtimeMs })
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Creates a temporary blob backed by the filesystem.
|
||||||
|
* NOTE: requires node.js v14 or higher to use FinalizationRegistry
|
||||||
|
*
|
||||||
|
* @param {*} data Same as fs.writeFile data
|
||||||
|
* @param {BlobPropertyBag & {signal?: AbortSignal}} options
|
||||||
|
* @param {AbortSignal} [signal] in case you wish to cancel the write operation
|
||||||
|
* @returns {Promise<Blob>}
|
||||||
|
*/
|
||||||
|
const createTemporaryBlob = async (data, {signal, type} = {}) => {
|
||||||
|
registry = registry || new FinalizationRegistry(fs.unlink)
|
||||||
|
tempDir = tempDir || await mkdtemp(realpathSync(tmpdir()) + sep)
|
||||||
|
const id = `${i++}`
|
||||||
|
const destination = join(tempDir, id)
|
||||||
|
if (data instanceof ArrayBuffer) data = new Uint8Array(data)
|
||||||
|
await fs.writeFile(destination, data, { signal })
|
||||||
|
const blob = await blobFrom(destination, type)
|
||||||
|
registry.register(blob, destination)
|
||||||
|
return blob
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Creates a temporary File backed by the filesystem.
|
||||||
|
* Pretty much the same as constructing a new File(data, name, options)
|
||||||
|
*
|
||||||
|
* NOTE: requires node.js v14 or higher to use FinalizationRegistry
|
||||||
|
* @param {*} data
|
||||||
|
* @param {string} name
|
||||||
|
* @param {FilePropertyBag & {signal?: AbortSignal}} opts
|
||||||
|
* @returns {Promise<File>}
|
||||||
|
*/
|
||||||
|
const createTemporaryFile = async (data, name, opts) => {
|
||||||
|
const blob = await createTemporaryBlob(data)
|
||||||
|
return new File([blob], name, opts)
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* This is a blob backed up by a file on the disk
|
* This is a blob backed up by a file on the disk
|
||||||
* with minium requirement. Its wrapped around a Blob as a blobPart
|
* with minium requirement. Its wrapped around a Blob as a blobPart
|
||||||
@@ -102,5 +147,18 @@ class BlobDataItem {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
process.once('exit', () => {
|
||||||
|
tempDir && rmdirSync(tempDir, { recursive: true })
|
||||||
|
})
|
||||||
|
|
||||||
export default blobFromSync
|
export default blobFromSync
|
||||||
export { File, Blob, blobFrom, blobFromSync, fileFrom, fileFromSync }
|
export {
|
||||||
|
Blob,
|
||||||
|
blobFrom,
|
||||||
|
blobFromSync,
|
||||||
|
createTemporaryBlob,
|
||||||
|
File,
|
||||||
|
fileFrom,
|
||||||
|
fileFromSync,
|
||||||
|
createTemporaryFile
|
||||||
|
}
|
||||||
+1
-1
@@ -35,7 +35,7 @@
|
|||||||
},
|
},
|
||||||
"homepage": "https://github.com/node-fetch/fetch-blob#readme",
|
"homepage": "https://github.com/node-fetch/fetch-blob#readme",
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@types/node": "^17.0.9",
|
"@types/node": "^18.0.2",
|
||||||
"c8": "^7.11.0",
|
"c8": "^7.11.0",
|
||||||
"typescript": "^4.5.4"
|
"typescript": "^4.5.4"
|
||||||
},
|
},
|
||||||
|
|||||||
+40
-1
@@ -3,7 +3,14 @@
|
|||||||
|
|
||||||
import fs from 'node:fs'
|
import fs from 'node:fs'
|
||||||
import buffer from 'node:buffer'
|
import buffer from 'node:buffer'
|
||||||
import syncBlob, { blobFromSync, blobFrom, fileFromSync, fileFrom } from '../from.js'
|
import syncBlob, {
|
||||||
|
blobFromSync,
|
||||||
|
blobFrom,
|
||||||
|
fileFromSync,
|
||||||
|
fileFrom,
|
||||||
|
createTemporaryBlob,
|
||||||
|
createTemporaryFile
|
||||||
|
} from '../from.js'
|
||||||
|
|
||||||
const license = fs.readFileSync('./LICENSE')
|
const license = fs.readFileSync('./LICENSE')
|
||||||
|
|
||||||
@@ -189,6 +196,38 @@ promise_test(async () => {
|
|||||||
assert_equals(await (await fileFrom('./LICENSE')).text(), license.toString())
|
assert_equals(await (await fileFrom('./LICENSE')).text(), license.toString())
|
||||||
}, 'blob part backed up by filesystem slice correctly')
|
}, 'blob part backed up by filesystem slice correctly')
|
||||||
|
|
||||||
|
promise_test(async () => {
|
||||||
|
let blob
|
||||||
|
// Can construct a temporary blob from a string
|
||||||
|
blob = await createTemporaryBlob(license.toString())
|
||||||
|
assert_equals(await blob.text(), license.toString())
|
||||||
|
|
||||||
|
// Can construct a temporary blob from a async iterator
|
||||||
|
blob = await createTemporaryBlob(blob.stream())
|
||||||
|
assert_equals(await blob.text(), license.toString())
|
||||||
|
|
||||||
|
// Can construct a temporary file from a arrayBuffer
|
||||||
|
blob = await createTemporaryBlob(await blob.arrayBuffer())
|
||||||
|
assert_equals(await blob.text(), license.toString())
|
||||||
|
|
||||||
|
// Can construct a temporary file from a arrayBufferView
|
||||||
|
blob = await createTemporaryBlob(await blob.arrayBuffer().then(ab => new Uint8Array(ab)))
|
||||||
|
assert_equals(await blob.text(), license.toString())
|
||||||
|
|
||||||
|
// Can specify a mime type
|
||||||
|
blob = await createTemporaryBlob('abc', { type: 'text/plain' })
|
||||||
|
assert_equals(blob.type, 'text/plain')
|
||||||
|
|
||||||
|
// Can create files too
|
||||||
|
let file = await createTemporaryFile('abc', 'abc.txt', {
|
||||||
|
type: 'text/plain',
|
||||||
|
lastModified: 123
|
||||||
|
})
|
||||||
|
assert_equals(file.name, 'abc.txt')
|
||||||
|
assert_equals(file.size, 3)
|
||||||
|
assert_equals(file.lastModified, 123)
|
||||||
|
}, 'creating temporary blob/file backed up by filesystem')
|
||||||
|
|
||||||
promise_test(async () => {
|
promise_test(async () => {
|
||||||
fs.writeFileSync('temp', '')
|
fs.writeFileSync('temp', '')
|
||||||
await blobFromSync('./temp').text()
|
await blobFromSync('./temp').text()
|
||||||
|
|||||||
Reference in New Issue
Block a user