Deno.ReadFileOptions | Runtime APIs | Deno

Skip to main content

Using Deno in production at your company? Earn free Deno merch.

Give us feedback

Menu

Go to LatestShow Unstable API

Broadcast Channel

BroadcastChannel

BroadcastChannelEventMap

Cache API

CacheQueryOptions

Compression Streams API

CompressionStream

DecompressionStream

Console and Debugging

Deno.InspectOptions

Deno.customInspect

DOM APIs

ErrorConstructor

MessageEventInit

MessagePortEventMap

StructuredSerializeOptions

PostMessageOptions

structuredClone

DOM Events

AddEventListenerOptions

CustomEventInit

EventListenerObject

EventListenerOptions

ProgressEventInit

EventListenerOrEventListenerObject

addEventListener

removeEventListener

Encoding API

TextDecodeOptions

TextDecoderOptions

TextDecoderStream

TextEncoderEncodeIntoResult

TextEncoderStream

Errors

Deno.errors.AddrInUse

Deno.errors.AddrNotAvailable

Deno.errors.AlreadyExists

Deno.errors.BadResource

Deno.errors.BrokenPipe

Deno.errors.Busy

Deno.errors.ConnectionAborted

Deno.errors.ConnectionRefused

Deno.errors.ConnectionReset

Deno.errors.FilesystemLoop

Deno.errors.Http

Deno.errors.Interrupted

Deno.errors.InvalidData

Deno.errors.IsADirectory

Deno.errors.NetworkUnreachable

Deno.errors.NotADirectory

Deno.errors.NotConnected

Deno.errors.NotFound

Deno.errors.NotSupported

Deno.errors.PermissionDenied

Deno.errors.TimedOut

Deno.errors.UnexpectedEof

Deno.errors.WouldBlock

Deno.errors.WriteZero

ES Modules

Fetch API

FormDataEntryValue

RequestCredentials

RequestDestination

RequestRedirect

File System

Deno.MakeTempOptions

Deno.MkdirOptions

Deno.OpenOptions

Deno.ReadFileOptions

Deno.RemoveOptions

Deno.SymlinkOptions

Deno.WriteFileOptions

Deno.FsEventFlag

Deno.copyFileSync

Deno.createSync

Deno.ftruncateSync

Deno.futimeSync

Deno.makeTempDir

Deno.makeTempDirSync

Deno.makeTempFile

Deno.makeTempFileSync

Deno.readDirSync

Deno.readFileSync

Deno.readLinkSync

Deno.readTextFile

Deno.readTextFileSync

Deno.realPathSync

Deno.removeSync

Deno.renameSync

Deno.symlinkSync

Deno.truncateSync

Deno.writeFileSync

Deno.writeTextFile

Deno.writeTextFileSync

HTTP Server

Deno.HttpServer

Deno.RequestEvent

Deno.ServeHandlerInfo

Deno.ServeOptions

Deno.ServeTlsOptions

Deno.ServeUnixHandlerInfo

Deno.ServeUnixInit

Deno.ServeHandler

Deno.ServeUnixHandler

I/O

Deno.ReaderSync

Deno.SeekerSync

Deno.SetRawOptions

Deno.WriterSync

Deno.consoleSize

Deno.fdatasyncSync

Deno.readAllSync

Deno.writeAllSync

Network

Deno.ConnectOptions

Deno.ConnectTlsOptions

Deno.ListenOptions

Deno.ListenTlsOptions

Deno.NAPTRRecord

Deno.NetworkInterfaceInfo

Deno.ResolveDnsOptions

Deno.StartTlsOptions

Deno.TcpListenOptions

Deno.TlsHandshakeInfo

Deno.RecordType

Deno.TlsListener

Deno.connectTls

Deno.networkInterfaces

Deno.resolveDns

Observability

Deno.ResourceMap

PromiseRejectionEvent

PromiseRejectionEventInit

onunhandledrejection

Performance

PerformanceEntry

PerformanceMark

PerformanceMarkOptions

PerformanceMeasure

PerformanceMeasureOptions

PerformanceEntryList

Permissions

Deno.Permissions

Deno.PermissionStatus

Deno.EnvPermissionDescriptor

Deno.FfiPermissionDescriptor

Deno.HrtimePermissionDescriptor

Deno.NetPermissionDescriptor

Deno.PermissionOptionsObject

Deno.PermissionStatusEventMap

Deno.ReadPermissionDescriptor

Deno.RunPermissionDescriptor

Deno.SysPermissionDescriptor

Deno.WritePermissionDescriptor

Deno.PermissionDescriptor

Deno.PermissionName

Deno.PermissionOptions

Deno.PermissionState

Deno.permissions

Runtime Environment

Deno.MemoryUsage

Deno.SystemMemoryInfo

Deno.mainModule

Deno.addSignalListener

Deno.memoryUsage

Deno.removeSignalListener

Deno.systemMemoryInfo

Scheduling

Streams API

ByteLengthQueuingStrategy

CountQueuingStrategy

QueuingStrategy

QueuingStrategySizeCallback

ReadableByteStreamController

ReadableByteStreamControllerCallback

ReadableStreamBYOBReadDoneResult

ReadableStreamBYOBReader

ReadableStreamBYOBReaderReadOptions

ReadableStreamBYOBReadValueResult

ReadableStreamBYOBRequest

ReadableStreamDefaultController

ReadableStreamDefaultControllerCallback

ReadableStreamDefaultReadDoneResult

ReadableStreamDefaultReader

ReadableStreamDefaultReadValueResult

ReadableStreamErrorCallback

TransformStream

TransformStreamDefaultController

TransformStreamDefaultControllerCallback

TransformStreamDefaultControllerTransformCallback

UnderlyingByteSource

UnderlyingSource

WritableStreamDefaultController

WritableStreamDefaultControllerCloseCallback

WritableStreamDefaultControllerStartCallback

WritableStreamDefaultControllerWriteCallback

WritableStreamDefaultWriter

WritableStreamErrorCallback

ReadableStreamBYOBReadResult

ReadableStreamDefaultReadResult

Sub Process

Deno.ChildProcess

Deno.CommandOptions

Deno.CommandOutput

Deno.CommandStatus

Deno.RunOptions

Deno.ProcessStatus

Testing

Deno.BenchContext

Deno.BenchDefinition

Deno.TestContext

Deno.TestDefinition

Deno.TestStepDefinition

Timers

Deno.unrefTimer

Typed Arrays

Web APIs

AbortController

AbortSignalEventMap

ImageDataSettings

URLPatternComponentResult

URLPatternResult

URLSearchParams

PredefinedColorSpace

URLPatternInput

Web Crypto API

AesDerivedKeyParams

AesKeyAlgorithm

AesKeyGenParams

EcdhKeyDeriveParams

EcKeyImportParams

HmacImportParams

HmacKeyAlgorithm

HmacKeyGenParams

RsaHashedImportParams

RsaHashedKeyAlgorithm

RsaHashedKeyGenParams

RsaKeyAlgorithm

RsaKeyGenParams

RsaOtherPrimesInfo

AlgorithmIdentifier

HashAlgorithmIdentifier

Web File API

BlobPropertyBag

FilePropertyBag

FileReaderEventMap

Web Sockets

Deno.UpgradeWebSocketOptions

Deno.WebSocketUpgrade

WebSocketEventMap

Deno.upgradeWebSocket

Web Storage API

Web Workers

AbstractWorkerEventMap

WebAssembly

WebAssembly.CompileError

WebAssembly.Global

WebAssembly.Instance

WebAssembly.LinkError

WebAssembly.Memory

WebAssembly.Module

WebAssembly.RuntimeError

WebAssembly.Table

WebAssembly.GlobalDescriptor

WebAssembly.MemoryDescriptor

WebAssembly.ModuleExportDescriptor

WebAssembly.ModuleImportDescriptor

WebAssembly.TableDescriptor

WebAssembly.WebAssemblyInstantiatedSource

WebAssembly.Exports

WebAssembly.ExportValue

WebAssembly.ImportExportKind

WebAssembly.Imports

WebAssembly.ImportValue

WebAssembly.ModuleImports

WebAssembly.TableKind

WebAssembly.ValueType

WebAssembly.compile

WebAssembly.compileStreaming

WebAssembly.instantiate

WebAssembly.instantiateStreaming

WebAssembly.validate

WebGPU

GPUBindGroupLayout

GPUCommandBuffer

GPUCommandEncoder

GPUComputePassEncoder

GPUComputePipeline

GPUOutOfMemoryError

GPUPipelineLayout

GPURenderBundle

GPURenderBundleEncoder

GPURenderPassEncoder

GPURenderPipeline

GPUShaderModule

GPUSupportedFeatures

GPUSupportedLimits

GPUTextureUsage

GPUValidationError

GPUBindGroupDescriptor

GPUBindGroupEntry

GPUBindGroupLayoutDescriptor

GPUBindGroupLayoutEntry

GPUBlendComponent

GPUBufferBinding

GPUBufferBindingLayout

GPUBufferDescriptor

GPUColorTargetState

GPUCommandBufferDescriptor

GPUCommandEncoderDescriptor

GPUCompilationInfo

GPUCompilationMessage

GPUComputePassDescriptor

GPUComputePassTimestampWrites

GPUComputePipelineDescriptor

GPUDepthStencilState

GPUDeviceDescriptor

GPUDeviceLostInfo

GPUExtent3DDict

GPUFragmentState

GPUImageCopyBuffer

GPUImageCopyTexture

GPUImageDataLayout

GPUMultisampleState

GPUObjectDescriptorBase

GPUOrigin3DDict

GPUPipelineBase

GPUPipelineDescriptorBase

GPUPipelineLayoutDescriptor

GPUPrimitiveState

GPUProgrammablePassEncoder

GPUProgrammableStage

GPUQuerySetDescriptor

GPURenderBundleDescriptor

GPURenderBundleEncoderDescriptor

GPURenderEncoderBase

GPURenderPassColorAttachment

GPURenderPassDepthStencilAttachment

GPURenderPassDescriptor

GPURenderPassLayout

GPURenderPassTimestampWrites

GPURenderPipelineDescriptor

GPURequestAdapterOptions

GPUSamplerBindingLayout

GPUSamplerDescriptor

GPUShaderModuleDescriptor

GPUStencilFaceState

GPUStorageTextureBindingLayout

GPUTextureBindingLayout

GPUTextureDescriptor

GPUTextureViewDescriptor

GPUVertexAttribute

GPUVertexBufferLayout

GPUAutoLayoutMode

GPUBindingResource

GPUBlendOperation

GPUBufferBindingType

GPUBufferMapState

GPUBufferUsageFlags

GPUColorWriteFlags

GPUCompareFunction

GPUCompilationMessageType

GPUDeviceLostReason

GPUFlagsConstant

GPUMapModeFlags

GPUMipmapFilterMode

GPUPowerPreference

GPUPrimitiveTopology

GPUSamplerBindingType

GPUShaderStageFlags

GPUStencilOperation

GPUStorageTextureAccess

GPUTextureAspect

GPUTextureDimension

GPUTextureFormat

GPUTextureSampleType

GPUTextureUsageFlags

GPUTextureViewDimension

GPUVertexFormat

GPUVertexStepMode

Deno.ServeUnixOptions

interface Deno.ReadFileOptions

Options which can be set when using Deno.readFile or Deno.readFileSync.

Properties

optional

signal: AbortSignal

An abort signal to allow cancellation of the file read operation. If the signal becomes aborted the readFile operation will be stopped and the promise returned will be rejected with an AbortError.