1.0.0-beta1

graalvm/elide.runtime.node.buffer/NodeFile

NodeFile

@DelicateElideApi

class NodeFile : NodeBlob, BufferAPI.File, ProxyObject

Implements the File class from the Node.js buffer built-in module. This class is basically a specialized NodeBlob with name and lastModified fields.

Constructors

constructor(sources: PolyglotValue, fileName: PolyglotValue)

Create a new NodeFile with the given sources and fileName, using default options. The sources value must have array elements of the supported type, meaning each item should either have buffer elements, or expose a buffer property that does. The fileName must be a string value.

constructor(sources: PolyglotValue, fileName: PolyglotValue, options: PolyglotValue?)

Create a new NodeFile with the given sources, fileName, and options. The sources value must have array elements of the supported type, meaning each item should either have buffer elements, or expose a buffer property that does. The fileName must be a string value.

Properties

open override val lastModified: Long

An epoch timestamp indicating the last modification to this file.

open override val name: String

The name of the file.

open override val size: Int

Size in bytes of this blob.

open override val type: String?

The content type of this Blob. Note that this value is informative only.

Functions

open override fun arrayBuffer(): JsPromise<PolyglotValue>

Returns a promise which resolves with a JavaScript ArrayBuffer object containing a copy of this blob's data.

open override fun getMember(key: String?): Any?

open override fun getMemberKeys(): Any

open override fun hasMember(key: String): Boolean

open override fun putMember(key: String?, value: PolyglotValue?)

open fun removeMember(key: String): Boolean

open override fun slice(start: Int?, end: Int?, type: String?): NodeBlob

Returns a copy of this blob between the requested indices, and optionally with a different type.

open override fun stream(): ReadableStream

Returns a stream that can be used to read the contents of this blob.

open override fun text(): JsPromise<String>

Returns a promise which resolves with the result of decoding this blob's data as a UTF-8 string.