mirror of
https://github.com/jackyzha0/quartz.git
synced 2025-12-25 13:54:05 -06:00
47 lines
1.9 KiB
Markdown
47 lines
1.9 KiB
Markdown
# web-file
|
|
|
|
[![ci][ci.icon]][ci.url]
|
|
[![package][version.icon] ![downloads][downloads.icon]][package.url]
|
|
[![styled with prettier][prettier.icon]][prettier.url]
|
|
|
|
Web API compatible [File][] for nodejs.
|
|
|
|
### Usage
|
|
|
|
```js
|
|
import { File, Blob } from "@web-std/file"
|
|
const file = new File(["hello", new TextEncoder().encode("world")], "hello")
|
|
for await (const chunk of blob.stream()) {
|
|
console.log(chunk)
|
|
}
|
|
```
|
|
|
|
### Usage from Typescript
|
|
|
|
This library makes use of [typescript using JSDOC annotations][ts-jsdoc] and
|
|
also generates type difinitions along with typed definition maps. So you should
|
|
be able to get all the type innference out of the box.
|
|
|
|
## Install
|
|
|
|
npm install @web-std/file
|
|
|
|
[ci.icon]: https://github.com/web-std/io/workflows/file/badge.svg
|
|
[ci.url]: https://github.com/web-std/io/actions/workflows/file.yml
|
|
[version.icon]: https://img.shields.io/npm/v/@web-std/file.svg
|
|
[downloads.icon]: https://img.shields.io/npm/dm/@web-std/file.svg
|
|
[package.url]: https://npmjs.org/package/@web-std/file
|
|
[downloads.image]: https://img.shields.io/npm/dm/@web-std/file.svg
|
|
[downloads.url]: https://npmjs.org/package/@web-std/file
|
|
[prettier.icon]: https://img.shields.io/badge/styled_with-prettier-ff69b4.svg
|
|
[prettier.url]: https://github.com/prettier/prettier
|
|
[blob]: https://developer.mozilla.org/en-US/docs/Web/API/Blob/Blob
|
|
[fetch-blob]: https://github.com/node-fetch/fetch-blob
|
|
[readablestream]: https://developer.mozilla.org/en-US/docs/Web/API/ReadableStream
|
|
[readable]: https://nodejs.org/api/stream.html#stream_readable_streams
|
|
[file]: https://w3c.github.io/FileAPI/
|
|
[for await]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/for-await...of
|
|
[buffer]: https://nodejs.org/api/buffer.html
|
|
[weakmap]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/WeakMap
|
|
[ts-jsdoc]: https://www.typescriptlang.org/docs/handbook/jsdoc-supported-types.html
|