FileAPI
Types
blob
A file-like object of immutable, raw data. Blobs represent data that isn't necessarily in a JavaScript-native format. The File interface is based on Blob, inheriting blob functionality and expanding it to support files on the user's system. See Blob on MDN
type blob = {size: int, type_: string}Record fields
Module
There are methods and helpers defined in Blob .
blobPart
@unboxed type blobPart = String(string) | Blob(blob)blobPropertyBag
type blobPropertyBag = { mutable type_?: string, mutable endings?: endingType,}Record fields
type_
endings
endingType
type endingType = | @as("native") Native | @as("transparent") Transparentfile
Provides information about files and allows JavaScript in a web page to access their content. See File on MDN
type file = { size: int, type_: string, name: string, lastModified: int, webkitRelativePath: string,}Record fields
Module
There are methods and helpers defined in File .
filePropertyBag
type filePropertyBag = { mutable type_?: string, mutable endings?: endingType, mutable lastModified?: int,}Record fields
type_
endings
lastModified
fileSystemCreateWritableOptions
type fileSystemCreateWritableOptions = { mutable keepExistingData?: bool,}Record fields
keepExistingData
fileSystemDirectoryHandle
type fileSystemDirectoryHandle = { kind: fileSystemHandleKind, name: string,}Record fields
Module
There are methods and helpers defined in FileSystemDirectoryHandle .
fileSystemFileHandle
type fileSystemFileHandle = { kind: fileSystemHandleKind, name: string,}Record fields
Module
There are methods and helpers defined in FileSystemFileHandle .
fileSystemGetDirectoryOptions
type fileSystemGetDirectoryOptions = {mutable create?: bool}Record fields
create
fileSystemGetFileOptions
type fileSystemGetFileOptions = {mutable create?: bool}Record fields
create
fileSystemHandle
type fileSystemHandle = { kind: fileSystemHandleKind, name: string,}Record fields
Module
There are methods and helpers defined in FileSystemHandle .
fileSystemHandleKind
type fileSystemHandleKind = | @as("directory") Directory | @as("file") FilefileSystemRemoveOptions
type fileSystemRemoveOptions = {mutable recursive?: bool}Record fields
recursive
fileSystemWritableFileStream
type fileSystemWritableFileStream = {locked: bool}Record fields
Module
There are methods and helpers defined in FileSystemWritableFileStream .
fileSystemWriteChunkType
type fileSystemWriteChunkType = WebAPI.Prelude.anyqueuingStrategy
type queuingStrategy<'t> = WebAPI.Prelude.anyreadableStream
This Streams API interface represents a readable stream of byte data. The Fetch API offers a concrete instance of a ReadableStream through the body property of a Response object. See ReadableStream on MDN
type readableStream<'r> = {locked: bool}Record fields
Module
There are methods and helpers defined in ReadableStream .
readableStreamGetReaderOptions
type readableStreamGetReaderOptions = { mutable mode?: readableStreamReaderMode,}Record fields
mode
Creates a ReadableStreamBYOBReader and locks the stream to the new reader.
This call behaves the same way as the no-argument variant, except that it only works on readable byte streams, i.e. streams which were constructed specifically with the ability to handle "bring your own buffer" reading. The returned BYOB reader provides the ability to directly read individual chunks from the stream via its read() method, into developer-supplied buffers, allowing more precise control over allocation.
readableStreamReader
type readableStreamReader<'t> = WebAPI.Prelude.anyreadableStreamReaderMode
type readableStreamReaderMode = @as("byob") ByobreadableWritablePair
type readableWritablePair<'r, 'w> = { mutable readable: readableStream<'r>, mutable writable: writableStream<'w>,}Record fields
readable
writable
Provides a convenient, chainable way of piping this readable stream through a transform stream (or any other { writable, readable } pair). It simply pipes the stream into the writable side of the supplied pair, and returns the readable side for further use.
Piping a stream will lock it for the duration of the pipe, preventing any other consumer from acquiring a reader.
streamPipeOptions
type streamPipeOptions = { mutable preventClose?: bool, mutable preventAbort?: bool, mutable preventCancel?: bool, mutable signal?: WebAPI.EventAPI.abortSignal,}Record fields
preventClose
Pipes this readable stream to a given writable stream destination. The way in which the piping process behaves under various error conditions can be customized with a number of passed options. It returns a promise that fulfills when the piping process completes successfully, or rejects if any errors were encountered.
Piping a stream will lock it for the duration of the pipe, preventing any other consumer from acquiring a reader.
Errors and closures of the source and destination streams propagate as follows:
An error in this source readable stream will abort destination, unless preventAbort is truthy. The returned promise will be rejected with the source's error, or with any error that occurs during aborting the destination.
An error in destination will cancel this source readable stream, unless preventCancel is truthy. The returned promise will be rejected with the destination's error, or with any error that occurs during canceling the source.
When this source readable stream closes, destination will be closed, unless preventClose is truthy. The returned promise will be fulfilled once this process completes, unless an error is encountered while closing the destination, in which case it will be rejected with that error.
If destination starts out closed or closing, this source readable stream will be canceled, unless preventCancel is true. The returned promise will be rejected with an error indicating piping to a closed stream failed, or with any error that occurs during canceling the source.
The signal option can be set to an AbortSignal to allow aborting an ongoing pipe operation via the corresponding AbortController. In this case, this source readable stream will be canceled, and destination aborted, unless the respective options preventCancel or preventAbort are set.
preventAbort
preventCancel
signal
underlyingByteSource
type underlyingByteSource = { mutable type_: unknown, mutable autoAllocateChunkSize?: int, mutable start?: unknown, mutable pull?: unknown, mutable cancel?: underlyingSourceCancelCallback,}Record fields
type_
autoAllocateChunkSize
start
pull
cancel
underlyingSink
type underlyingSink<'t> = WebAPI.Prelude.anyunderlyingSourceCancelCallback
type underlyingSourceCancelCallback = JSON.t => Promise.t< unit,>writableStream
This Streams API interface provides a standard abstraction for writing streaming data to a destination, known as a sink. This object comes with built-in backpressure and queuing. See WritableStream on MDN
type writableStream<'w> = {locked: bool}Record fields
Module
There are methods and helpers defined in WritableStream .
writableStreamDefaultController
This Streams API interface represents a controller allowing control of a WritableStream's state. When constructing a WritableStream, the underlying sink is given a corresponding WritableStreamDefaultController instance to manipulate. See WritableStreamDefaultController on MDN
type writableStreamDefaultController = { signal: WebAPI.EventAPI.abortSignal,}Record fields
Module
There are methods and helpers defined in WritableStreamDefaultController .
writableStreamDefaultWriter
type writableStreamDefaultWriter<'t> = WebAPI.Prelude.anywriteCommandType
type writeCommandType = | @as("seek") Seek | @as("truncate") Truncate | @as("write") WritewriteParams
type writeParams = { mutable type_: writeCommandType, mutable size?: Null.t<int>, mutable position?: Null.t<int>, mutable data?: Null.t<unknown>,}