Skip to main content
Deno - Deno documentation
namespace Deno

The global namespace where Deno specific, non-standard APIs are located.

Classes

c
Deno.AtomicOperation

An operation on a Deno.Kv that can be performedatomically. Atomic operations do not auto-commit, and must be committedexplicitly by calling the commit method.

c
Deno.ChildProcess

The interface for handling a child process returned fromDeno.Command.spawn.

c
Deno.Command

Create a child process.

c
Deno.HttpClient

A custom HttpClient for use with fetch function. This isdesigned to allow custom certificates or proxies to be used with fetch().

c
Deno.Kv

A key-value database that can be used to store and retrieve data.

c
Deno.KvListIterator

An iterator over a range of data entries in a Deno.Kv.

c
Deno.KvU64

Wrapper type for 64-bit unsigned integers for use as values in aDeno.Kv.

c
Deno.PermissionStatus

An EventTarget returned from the Deno.permissionsAPI which can provide updates to any state changes of the permission.

c
Deno.UnsafeCallback

An unsafe function pointer for passing JavaScript functions as C functionpointers to foreign function calls.

c
Deno.UnsafeFnPointer

An unsafe pointer to a function, for calling functions that are not presentas symbols.

c
Deno.UnsafePointer

A collection of static functions for interacting with pointer objects.

c
Deno.UnsafePointerView

An unsafe pointer view to a memory location as specified by the pointervalue. The UnsafePointerView API follows the standard built in interfaceDataView for accessing the underlying types at an memorylocation (numbers, strings and raw bytes).

c
Deno.UnsafeWindowSurface

Creates a presentable WebGPU surface from given window anddisplay handles.

Enums

E
Deno.SeekMode

A enum which defines the seek mode for IO related APIs that supportseeking.

Functions

f
Deno.addSignalListener

Registers the given function as a listener of the given signal event.

f
Deno.bench

Register a benchmark test which will be run when deno bench is used onthe command line and the containing module looks like a bench module.

f
Deno.chdir

Change the current working directory to the specified path.

f
Deno.chmod

Changes the permission of a specific file/directory of specified path.Ignores the process's umask.

f
Deno.chmodSync

Synchronously changes the permission of a specific file/directory ofspecified path. Ignores the process's umask.

f
Deno.chown

Change owner of a regular file or directory.

f
Deno.chownSync

Synchronously change owner of a regular file or directory.

f
Deno.connect

Connects to the hostname (default is "127.0.0.1") and port on the namedtransport (default is "tcp"), and resolves to the connection (Conn).

f
Deno.connectTls

Establishes a secure connection over TLS (transport layer security) usingan optional list of CA certs, hostname (default is "127.0.0.1") and port.

f
Deno.consoleSize

Gets the size of the console as columns/rows.

f
Deno.copyFile

Copies the contents and permissions of one file to another specified path,by default creating a new file if needed, else overwriting. Fails if targetpath is a directory or is unwritable.

f
Deno.copyFileSync

Synchronously copies the contents and permissions of one file to anotherspecified path, by default creating a new file if needed, else overwriting.Fails if target path is a directory or is unwritable.

f
Deno.create

Creates a file if none exists or truncates an existing file and resolves toan instance of Deno.FsFile.

f
Deno.createHttpClient

Create a custom HttpClient to use with fetch. This is anextension of the web platform Fetch API which allows Deno to use customTLS CA certificates and connect via a proxy while using fetch().

f
Deno.createSync

Creates a file if none exists or truncates an existing file and returnsan instance of Deno.FsFile.

f
Deno.cron

Create a cron job that will periodically execute the provided handlercallback based on the specified schedule.

f
Deno.cwd

Return a string representing the current working directory.

f
Deno.dlopen

Opens an external dynamic library and registers symbols, making foreignfunctions available to be called.

f
Deno.execPath

Returns the path to the current deno executable.

f
Deno.exit

Exit the Deno process with optional exit code.

f
Deno.gid

Returns the group id of the process on POSIX platforms. Returns null on windows.

f
Deno.hostname

Get the hostname of the machine the Deno process is running on.

f
Deno.inspect

Converts the input into a string that has the same format as printed byconsole.log().

f
Deno.kill

Send a signal to process under given pid. The value and meaning of thesignal to the process is operating system and process dependant.Signal provides the most common signals. Default signalis "SIGTERM".

f
Deno.linkSync

Synchronously creates newpath as a hard link to oldpath.

f
Deno.listen

Listen announces on the local transport address.

f
Deno.listenDatagram

Listen announces on the local transport address.

f
Deno.listenTls

Listen announces on the local transport address over TLS (transport layersecurity).

f
Deno.loadavg

Returns an array containing the 1, 5, and 15 minute load averages. Theload average is a measure of CPU and IO utilization of the last one, five,and 15 minute periods expressed as a fractional number. Zero means thereis no load. On Windows, the three values are always the same and representthe current load, not the 1, 5 and 15 minute load averages.

f
Deno.lstat

Resolves to a Deno.FileInfo for the specified path. Ifpath is a symlink, information for the symlink will be returned insteadof what it points to.

f
Deno.lstatSync

Synchronously returns a Deno.FileInfo for the specifiedpath. If path is a symlink, information for the symlink will bereturned instead of what it points to.

f
Deno.makeTempDir

Creates a new temporary directory in the default directory for temporaryfiles, unless dir is specified. Other optional options includeprefixing and suffixing the directory name with prefix and suffixrespectively.

f
Deno.makeTempDirSync

Synchronously creates a new temporary directory in the default directoryfor temporary files, unless dir is specified. Other optional optionsinclude prefixing and suffixing the directory name with prefix andsuffix respectively.

f
Deno.makeTempFile

Creates a new temporary file in the default directory for temporaryfiles, unless dir is specified.

f
Deno.makeTempFileSync

Synchronously creates a new temporary file in the default directory fortemporary files, unless dir is specified.

f
Deno.memoryUsage

Returns an object describing the memory usage of the Deno process and theV8 subsystem measured in bytes.

f
Deno.mkdir

Creates a new directory with the specified path.

f
Deno.mkdirSync

Synchronously creates a new directory with the specified path.

f
Deno.networkInterfaces

Returns an array of the network interface information.

f
Deno.open

Open a file and resolve to an instance of Deno.FsFile. Thefile does not need to previously exist if using the create or createNewopen options. The caller may have the resulting file automatically closedby the runtime once it's out of scope by declaring the file variable withthe using keyword.

f
Deno.openKv

Open a new Deno.Kv connection to persist data.

f
Deno.openSync

Synchronously open a file and return an instance ofDeno.FsFile. The file does not need to previously exist ifusing the create or createNew open options. The caller may have theresulting file automatically closed by the runtime once it's out of scopeby declaring the file variable with the using keyword.

f
Deno.osRelease

Returns the release version of the Operating System.

f
Deno.osUptime

Returns the Operating System uptime in number of seconds.

f
Deno.readDir

Reads the directory given by path and returns an async iterable ofDeno.DirEntry. The order of entries is not guaranteed.

f
Deno.readDirSync

Synchronously reads the directory given by path and returns an iterableof Deno.DirEntry. The order of entries is not guaranteed.

f
Deno.readFile

Reads and resolves to the entire contents of a file as an array of bytes.TextDecoder can be used to transform the bytes to string if required.Reading a directory returns an empty data array.

f
Deno.readFileSync

Synchronously reads and returns the entire contents of a file as an arrayof bytes. TextDecoder can be used to transform the bytes to string ifrequired. Reading a directory returns an empty data array.

f
Deno.readLinkSync

Synchronously returns the full path destination of the named symboliclink.

f
Deno.readTextFile

Asynchronously reads and returns the entire contents of a file as an UTF-8decoded string. Reading a directory throws an error.

f
Deno.readTextFileSync

Synchronously reads and returns the entire contents of a file as an UTF-8decoded string. Reading a directory throws an error.

f
Deno.realPath

Resolves to the absolute normalized path, with symbolic links resolved.

f
Deno.realPathSync

Synchronously returns absolute normalized path, with symbolic linksresolved.

f
Deno.refTimer

Make the timer of the given id block the event loop from finishing.

f
Deno.remove

Removes the named file or directory.

f
Deno.removeSignalListener

Removes the given signal listener that has been registered withDeno.addSignalListener.

f
Deno.removeSync

Synchronously removes the named file or directory.

f
Deno.rename

Renames (moves) oldpath to newpath. Paths may be files or directories.If newpath already exists and is not a directory, rename() replaces it.OS-specific restrictions may apply when oldpath and newpath are indifferent directories.

f
Deno.renameSync

Synchronously renames (moves) oldpath to newpath. Paths may be files ordirectories. If newpath already exists and is not a directory,renameSync() replaces it. OS-specific restrictions may apply whenoldpath and newpath are in different directories.

f
Deno.resolveDns

Performs DNS resolution against the given query, returning resolvedrecords.

f
Deno.serve

Serves HTTP requests with the given handler.

f
Deno.startTls

Start TLS handshake from an existing connection using an optional list ofCA certificates, and hostname (default is "127.0.0.1"). Specifying CA certsis optional. By default the configured root certificates are used. Usingthis function requires that the other end of the connection is prepared fora TLS handshake.

f
Deno.stat

Resolves to a Deno.FileInfo for the specified path. Willalways follow symlinks.

f
Deno.statSync

Synchronously returns a Deno.FileInfo for the specifiedpath. Will always follow symlinks.

f
Deno.symlinkSync

Creates newpath as a symbolic link to oldpath.

f
Deno.systemMemoryInfo

Displays the total amount of free and used physical and swap memory in thesystem, as well as the buffers and caches used by the kernel.

f
Deno.truncate

Truncates (or extends) the specified file, to reach the specified len.If len is not specified then the entire file contents are truncated.

f
Deno.truncateSync

Synchronously truncates (or extends) the specified file, to reach thespecified len. If len is not specified then the entire file contentsare truncated.

f
Deno.uid

Returns the user id of the process on POSIX platforms. Returns null on Windows.

f
Deno.umask

Retrieve the process umask. If mask is provided, sets the process umask.This call always returns what the umask was before the call.

f
Deno.unrefTimer

Make the timer of the given id not block the event loop from finishing.

f
Deno.upgradeWebSocket

Upgrade an incoming HTTP request to a WebSocket.

f
Deno.utime

Changes the access (atime) and modification (mtime) times of a filesystem object referenced by path. Given times are either in seconds(UNIX epoch time) or as Date objects.

f
Deno.utimeSync

Synchronously changes the access (atime) and modification (mtime) timesof a file system object referenced by path. Given times are either inseconds (UNIX epoch time) or as Date objects.

f
Deno.watchFs

Watch for file system events against one or more paths, which can befiles or directories. These paths must exist already. One user action (e.g.touch test.file) can generate multiple file system events. Likewise,one user action can result in multiple file paths in one event (e.g. mv old_name.txt new_name.txt).

f
Deno.writeFile

Write data to the given path, by default creating a new file ifneeded, else overwriting.

f
Deno.writeFileSync

Synchronously write data to the given path, by default creating a newfile if needed, else overwriting.

f
Deno.writeTextFile

Write string data to the given path, by default creating a new file ifneeded, else overwriting.

f
Deno.writeTextFileSync

Synchronously write string data to the given path, by default creatinga new file if needed, else overwriting.

Interfaces

I
Deno.AtomicCheck

A check to perform as part of a Deno.AtomicOperation. The checkwill fail if the versionstamp for the key-value pair in the KV store doesnot match the given versionstamp. A check with a null versionstamp checksthat the key-value pair does not currently exist in the KV store.

I
Deno.BasicAuth

Basic authentication credentials to be used with a Deno.Proxyserver when specifying Deno.CreateHttpClientOptions.

I
Deno.BenchContext

Context that is passed to a benchmarked function. The instance is sharedbetween iterations of the benchmark. Its methods can be used for exampleto override of the measured portion of the function.

I
I
Deno.CaaRecord

If Deno.resolveDns is called with "CAA" record typespecified, it will resolve with an array of objects with this interface.

I
Deno.CommandOutput

The interface returned from calling Deno.Command.output orDeno.Command.outputSync which represents the result of spawning thechild process.

I
Deno.CommandStatus
No documentation available
I
Deno.ConnectOptions
No documentation available
I
Deno.CronSchedule

CronSchedule is the interface used for JSON formatcron schedule.

I
Deno.DatagramConn

A generic transport listener for message-oriented protocols.

I
Deno.DenoTest
No documentation available
I
Deno.DirEntry

Information about a directory entry returned from Deno.readDirand Deno.readDirSync.

I
Deno.DynamicLibrary

A dynamic library resource. Use Deno.dlopen to load a dynamiclibrary and return this interface.

I
Deno.Env

An interface containing methods to interact with the process environmentvariables.

I
Deno.EnvPermissionDescriptor

The permission descriptor for the allow-env and deny-env permissions, which controlsaccess to being able to read and write to the process environment variablesas well as access other information about the environment. The optionvariable allows scoping the permission to a specific environmentvariable.

I
Deno.FfiPermissionDescriptor

The permission descriptor for the allow-ffi and deny-ffi permissions, which controlsaccess to loading foreign code and interfacing with it via theForeign Function Interface APIavailable in Deno. The option path allows scoping the permission to aspecific path on the host.

I
Deno.ForeignFunction

The interface for a foreign function as defined by its parameter and resulttypes.

I
Deno.ForeignLibraryInterface

A foreign library interface descriptor.

I
Deno.ForeignStatic
No documentation available
I
Deno.FsEvent

Represents a unique file system event yielded by aDeno.FsWatcher.

I
Deno.FsWatcher

Returned by Deno.watchFs. It is an async iterator yielding upsystem events. To stop watching the file system by calling .close()method.

I
Deno.HttpServer

An instance of the server created using Deno.serve() API.

I
Deno.KvCommitError
No documentation available
I
Deno.KvCommitResult
No documentation available
I
Deno.KvEntry

A versioned pair of key and value in a Deno.Kv.

I
Deno.KvListOptions

Options for listing key-value pairs in a Deno.Kv.

I
Deno.Listener

A generic network listener for stream-oriented protocols.

I
Deno.ListenOptions
No documentation available
I
I
I
Deno.MkdirOptions

Options which can be set when using Deno.mkdir andDeno.mkdirSync.

I
Deno.MulticastV4Membership

Represents membership of a IPv4 multicast group.

I
Deno.MulticastV6Membership

Represents membership of a IPv6 multicast group.

I
Deno.MxRecord

If Deno.resolveDns is called with "MX" record typespecified, it will return an array of objects with this interface.

I
Deno.NaptrRecord

If Deno.resolveDns is called with "NAPTR" record typespecified, it will return an array of objects with this interface.

I
Deno.NativeStructType

The native struct type for interfacing with foreign functions.

I
Deno.NetAddr
No documentation available
I
Deno.NetPermissionDescriptor

The permission descriptor for the allow-net and deny-net permissions, which controlsaccess to opening network ports and connecting to remote hosts via thenetwork. The option host allows scoping the permission for outboundconnection to a specific host and port.

I
Deno.NetworkInterfaceInfo

The information for a network interface returned from a call toDeno.networkInterfaces.

I
Deno.PermissionOptionsObject

A set of options which can define the permissions within a test or workercontext at a highly specific level.

I
Deno.PermissionStatusEventMap

The interface which defines what event types are supported byPermissionStatus instances.

I
Deno.PointerObject

A non-null pointer, represented as an objectat runtime. The object's prototype is nulland cannot be changed. The object cannot beassigned to either and is thus entirely read-only.

I
Deno.Proxy

The definition of a proxy when specifyingDeno.CreateHttpClientOptions.

I
Deno.ReadFileOptions

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

I
Deno.ReadPermissionDescriptor

The permission descriptor for the allow-read and deny-read permissions, which controlsaccess to reading resources from the local host. The option path allowsscoping the permission to a specific path (and if the path is a directoryany sub paths).

I
Deno.RemoveOptions

Options which can be set when using Deno.remove andDeno.removeSync.

I
Deno.ResolveDnsOptions

Options which can be set when using Deno.resolveDns.

I
Deno.RunPermissionDescriptor

The permission descriptor for the allow-run and deny-run permissions, which controlsaccess to what sub-processes can be executed by Deno. The option commandallows scoping the permission to a specific executable.

I
Deno.ServeDefaultExport

Interface that module run with deno serve subcommand must conform to.

I
Deno.ServeHandlerInfo

Additional information for an HTTP request and its connection.

I
Deno.ServeInit
No documentation available
I
Deno.ServeOptions

Options which can be set when calling Deno.serve.

I
Deno.ServeTcpOptions

Options that can be passed to Deno.serve to create a server listening ona TCP port.

I
Deno.ServeUnixOptions

Options that can be passed to Deno.serve to create a server listening ona Unix domain socket.

I
Deno.SetRawOptions
No documentation available
I
Deno.SoaRecord

If Deno.resolveDns is called with "SOA" record typespecified, it will return an array of objects with this interface.

I
Deno.SrvRecord

If Deno.resolveDns is called with "SRV" record typespecified, it will return an array of objects with this interface.

I
Deno.SymlinkOptions

Options that can be used with symlink andsymlinkSync.

I
Deno.SysPermissionDescriptor

The permission descriptor for the allow-sys and deny-sys permissions, which controlsaccess to sensitive host system information, which malicious code mightattempt to exploit. The option kind allows scoping the permission to aspecific piece of information.

I
Deno.TcpConn
No documentation available
I
Deno.TcpListenOptions
No documentation available
I
Deno.TestContext

Context that is passed to a testing function, which can be used to eithergain information about the current test, or register additional teststeps within the current test.

I
Deno.TlsCertifiedKeyPem

Provides certified key material from strings. The key material is provided inPEM-format (Privacy Enhanced Mail, https://www.rfc-editor.org/rfc/rfc1422) which can be identified by having-----BEGIN----- and -----END----- markers at the beginning and end of the strings. This type of key is not compatiblewith DER-format keys which are binary.

I
Deno.TlsConn
No documentation available
I
Deno.TlsHandshakeInfo
No documentation available
I
Deno.UdpListenOptions

Unstable options which can be set when opening a datagram listener viaDeno.listenDatagram.

I
Deno.UnixAddr
No documentation available
I
Deno.UnixConn
No documentation available
I
Deno.UnixConnectOptions
No documentation available
I
Deno.UnixListenOptions

Options which can be set when opening a Unix listener viaDeno.listen or Deno.listenDatagram.

I
Deno.UnsafeCallbackDefinition

Definition of a unsafe callback function.

I
Deno.UpgradeWebSocketOptions

Options which can be set when performing aDeno.upgradeWebSocket upgrade of a Request

I
Deno.WebSocketUpgrade

The object that is returned from a Deno.upgradeWebSocketrequest.

I
I
Deno.WritePermissionDescriptor

The permission descriptor for the allow-write and deny-write permissions, whichcontrols access to writing to resources from the local host. The optionpath allow scoping the permission to a specific path (and if the path isa directory any sub paths).

Namespaces

N
Deno.errors

A set of error constructors that are raised by Deno APIs.

N
Deno.jupyter

A namespace containing runtime APIs available in Jupyter notebooks.

Type Aliases

T
Deno.Addr
No documentation available
T
Deno.ConditionalAsync
No documentation available
T
Deno.CronScheduleExpression

CronScheduleExpression is used as the type of minute, hour,dayOfMonth, month, and dayOfWeek in CronSchedule.

T
Deno.FromForeignFunction
No documentation available
T
Deno.FromNativeParameterTypes
No documentation available
T
Deno.FromNativeResultType

Type conversion for foreign symbol return types.

T
Deno.FromNativeType

Type conversion for foreign symbol return types and unsafe callbackparameters.

T
Deno.FsEventFlag

Additional information for FsEvent objects with the "other" kind.

T
Deno.KvConsistencyLevel

Consistency level of a KV operation.

T
Deno.KvEntryMaybe

An optional versioned pair of key and value in a Deno.Kv.

T
Deno.KvKey

A key to be persisted in a Deno.Kv. A key is a sequenceof Deno.KvKeyParts.

T
Deno.KvKeyPart

A single part of a Deno.KvKey. Parts are orderedlexicographically, first by their type, and within a given type by theirvalue.

T
Deno.KvListSelector

A selector that selects the range of data returned by a list operation on aDeno.Kv.

T
Deno.KvMutation

A mutation to a key in a Deno.Kv. A mutation is acombination of a key, a value, and a type. The type determines how themutation is applied to the key.

T
Deno.NativeBigIntType

All BigInt number types for interfacing with foreign functions.

T
Deno.NativeBooleanType

The native boolean type for interfacing to foreign functions.

T
Deno.NativeBufferType

The native buffer type for interfacing to foreign functions.

T
Deno.NativeFunctionType

The native function type for interfacing with foreign functions.

T
Deno.NativeI16Enum
No documentation available
T
Deno.NativeI32Enum
No documentation available
T
Deno.NativeI8Enum
No documentation available
T
Deno.NativeNumberType

All plain number types for interfacing with foreign functions.

T
Deno.NativePointerType

The native pointer type for interfacing to foreign functions.

T
Deno.NativeResultType
No documentation available
T
Deno.NativeType

All supported types for interfacing with foreign functions.

T
Deno.NativeTypedFunction
No documentation available
T
Deno.NativeTypedPointer
No documentation available
T
Deno.NativeU16Enum
No documentation available
T
Deno.NativeU32Enum
No documentation available
T
Deno.NativeU8Enum
No documentation available
T
Deno.NativeVoidType

The native void type for interfacing with foreign functions.

T
Deno.PermissionDescriptor

Permission descriptors which define a permission and can be queried,requested, or revoked.

T
Deno.PermissionName

The name of a privileged feature which needs permission.

T
Deno.PermissionOptions

Options which define the permissions within a test or worker context.

T
Deno.PermissionState

The current status of the permission:

T
Deno.PointerValue

Pointers are represented either with a PointerObjectobject or a null if the pointer is null.

T
Deno.RecordType

The type of the resource record to resolve via DNS usingDeno.resolveDns.

T
Deno.ServeHandler

A handler for HTTP requests. Consumes a request and returns a response.

T
Deno.Signal

Operating signals which can be listened for or sent to sub-processes. Whatsignals and what their standard behaviors are OS dependent.

T
Deno.StaticForeignLibraryInterface

A utility type that infers a foreign library interface.

T
Deno.StaticForeignSymbol

A utility type that infers a foreign symbol.

T
Deno.StaticForeignSymbolReturnType
No documentation available
T
Deno.TcpListener

Specialized listener that accepts TCP connections.

T
Deno.TlsListener

Specialized listener that accepts TLS connections.

T
Deno.ToNativeParameterTypes

A utility type for conversion of parameter types of foreign functions.

T
Deno.ToNativeResultType

Type conversion for unsafe callback return types.

T
Deno.ToNativeType

Type conversion for foreign symbol parameters and unsafe callback returntypes.

T
Deno.UnixListener

Specialized listener that accepts Unix connections.

T
Deno.UnsafeCallbackFunction

An unsafe callback function.

Variables

v
Deno.args

Returns the script arguments to the program.

v
Deno.brand
No documentation available
v
Deno.build

Information related to the build of the current Deno runtime.

v
Deno.env

An interface containing methods to interact with the process environmentvariables.

v
Deno.exitCode

The exit code for the Deno process.

v
Deno.mainModule

The URL of the entrypoint module entered from the command-line. Itrequires read permission to the CWD.

v
Deno.noColor

Reflects the NO_COLOR environment variable at program start.

v
Deno.permissions

Deno's permission management API.

v
Deno.pid

The current process ID of this instance of the Deno CLI.

v
Deno.ppid

The process ID of parent process of this instance of the Deno CLI.

v
Deno.stderr

A reference to stderr which can be used to write directly to stderr.It implements the Deno specificWriter,WriterSync,and Closer interfaces as well as provides aWritableStream interface.

v
Deno.stdin

A reference to stdin which can be used to read directly from stdin.

v
Deno.stdout

A reference to stdout which can be used to write directly to stdout.It implements the Deno specificWriter,WriterSync,and Closer interfaces as well as provides aWritableStream interface.

v
Deno.test

Register a test which will be run when deno test is used on the commandline and the containing module looks like a test module.

v
Deno.version

Version information related to the current Deno CLI runtime environment.