W↓
All docs
🔑
Sign Up/Sign In
docs.deno.com/api/deno
Public Link
Apr 8, 2025, 12:54:37 PM - complete - 37.4 kB
Created by:
****ad@vlad.studio
Starting URLs:
https://docs.deno.com/api/deno
CSS Selector:
.markdown-body
## Page: https://docs.deno.com/api/deno * Deno * Deno # 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 performed atomically. Atomic operations do not auto-commit, and must be committed explicitly by calling the `commit` method. * check * commit * delete * enqueue * max * min * mutate * set * sum c Deno.ChildProcess The interface for handling a child process returned from `Deno.Command.spawn`. * kill * output * pid * ref * status * stderr * stdin * stdout * unref c Deno.Command Create a child process. * output * outputSync * spawn c Deno.FsFile The Deno abstraction for reading and writing files. * close * isTerminal * lock * lockSync * read * readSync * readable * seek * seekSync * setRaw * stat * statSync * sync * syncData * syncDataSync * syncSync * truncate * truncateSync * unlock * unlockSync * utime * utimeSync * writable * write * writeSync c Deno.HttpClient A custom `HttpClient` for use with `fetch` function. This is designed to allow custom certificates or proxies to be used with `fetch()`. * close c Deno.Kv A key-value database that can be used to store and retrieve data. * atomic * close * commitVersionstamp * delete * enqueue * get * getMany * list * listenQueue * set * watch c Deno.KvListIterator An iterator over a range of data entries in a `Deno.Kv`. * cursor * next c Deno.KvU64 Wrapper type for 64-bit unsigned integers for use as values in a `Deno.Kv`. * value c Deno.Permissions Deno's permission management API. * query * querySync * request * requestSync * revoke * revokeSync c Deno.PermissionStatus An `EventTarget` returned from the `Deno.permissions` API which can provide updates to any state changes of the permission. * addEventListener * onchange * partial * removeEventListener * state c Deno.QuicEndpoint No documentation available * addr * close * listen c Deno.UnsafeCallback An unsafe function pointer for passing JavaScript functions as C function pointers to foreign function calls. * callback * close * definition * pointer * ref * threadSafe * unref c Deno.UnsafeFnPointer An unsafe pointer to a function, for calling functions that are not present as symbols. * call * definition * pointer c Deno.UnsafePointer A collection of static functions for interacting with pointer objects. * create * equals * of * offset * value c Deno.UnsafePointerView An unsafe pointer view to a memory location as specified by the `pointer` value. The `UnsafePointerView` API follows the standard built in interface `DataView` for accessing the underlying types at an memory location (numbers, strings and raw bytes). * copyInto * getArrayBuffer * getBigInt64 * getBigUint64 * getBool * getCString * getFloat32 * getFloat64 * getInt16 * getInt32 * getInt8 * getPointer * getUint16 * getUint32 * getUint8 * pointer c Deno.UnsafeWindowSurface Creates a presentable WebGPU surface from given window and display handles. * getContext * present ### Enums # E Deno.SeekMode A enum which defines the seek mode for IO related APIs that support seeking. ### 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 on the 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 of specified 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 named transport (default is "tcp"), and resolves to the connection (`Conn`). f Deno.connectQuic Establishes a secure connection over QUIC using a hostname and port. The cert file is optional and if not included Mozilla's root certificates will be used. See also https://github.com/ctz/webpki-roots for specifics. f Deno.connectTls Establishes a secure connection over TLS (transport layer security) using an 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 target path is a directory or is unwritable. f Deno.copyFileSync Synchronously copies the contents and permissions of one file to another specified 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 to an instance of `Deno.FsFile`. f Deno.createHttpClient Create a custom HttpClient to use with `fetch`. This is an extension of the web platform Fetch API which allows Deno to use custom TLS 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 returns an instance of `Deno.FsFile`. f Deno.cron Create a cron job that will periodically execute the provided handler callback 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 foreign functions 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 by `console.log()`. f Deno.kill Send a signal to process under given `pid`. The value and meaning of the `signal` to the process is operating system and process dependant. `Signal` provides the most common signals. Default signal is `"SIGTERM"`. f Deno.link Creates `newpath` as a hard link to `oldpath`. 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 layer security). f Deno.loadavg Returns an array containing the 1, 5, and 15 minute load averages. The load 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 there is no load. On Windows, the three values are always the same and represent the current load, not the 1, 5 and 15 minute load averages. f Deno.lstat Resolves to a `Deno.FileInfo` for the specified `path`. If `path` is a symlink, information for the symlink will be returned instead of what it points to. f Deno.lstatSync Synchronously returns a `Deno.FileInfo` for the specified `path`. If `path` is a symlink, information for the symlink will be returned instead of what it points to. f Deno.makeTempDir Creates a new temporary directory in the default directory for temporary files, unless `dir` is specified. Other optional options include prefixing and suffixing the directory name with `prefix` and `suffix` respectively. f Deno.makeTempDirSync Synchronously creates a new temporary directory in the default directory for temporary files, unless `dir` is specified. Other optional options include prefixing and suffixing the directory name with `prefix` and `suffix` respectively. f Deno.makeTempFile Creates a new temporary file in the default directory for temporary files, unless `dir` is specified. f Deno.makeTempFileSync Synchronously creates a new temporary file in the default directory for temporary files, unless `dir` is specified. f Deno.memoryUsage Returns an object describing the memory usage of the Deno process and the V8 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`. The file does not need to previously exist if using the `create` or `createNew` open options. The caller may have the resulting file automatically closed by the runtime once it's out of scope by declaring the file variable with the `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 of `Deno.FsFile`. The file does not need to previously exist if using the `create` or `createNew` open options. The caller may have the resulting file automatically closed by the runtime once it's out of scope by 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 of `Deno.DirEntry`. The order of entries is not guaranteed. f Deno.readDirSync Synchronously reads the directory given by `path` and returns an iterable of `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. Rejects with an error when reading a directory. f Deno.readFileSync Synchronously reads and returns the entire contents of a file as an array of bytes. `TextDecoder` can be used to transform the bytes to string if required. Throws an error when reading a directory. f Deno.readLink Resolves to the full path destination of the named symbolic link. f Deno.readLinkSync Synchronously returns the full path destination of the named symbolic link. f Deno.readTextFile Asynchronously reads and returns the entire contents of a file as an UTF-8 decoded string. Reading a directory throws an error. f Deno.readTextFileSync Synchronously reads and returns the entire contents of a file as an UTF-8 decoded 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 links resolved. 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 with `Deno.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 in different directories. f Deno.renameSync Synchronously renames (moves) `oldpath` to `newpath`. Paths may be files or directories. If `newpath` already exists and is not a directory, `renameSync()` replaces it. OS-specific restrictions may apply when `oldpath` and `newpath` are in different directories. f Deno.resolveDns Performs DNS resolution against the given query, returning resolved records. f Deno.serve Serves HTTP requests with the given handler. f Deno.startTls Start TLS handshake from an existing connection using an optional list of CA certificates, and hostname (default is "127.0.0.1"). Specifying CA certs is optional. By default the configured root certificates are used. Using this function requires that the other end of the connection is prepared for a TLS handshake. f Deno.stat Resolves to a `Deno.FileInfo` for the specified `path`. Will always follow symlinks. f Deno.statSync Synchronously returns a `Deno.FileInfo` for the specified `path`. Will always follow symlinks. f Deno.symlink Creates `newpath` as a symbolic link to `oldpath`. 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 the system, 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 the specified `len`. If `len` is not specified then the entire file contents are 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.upgradeWebTransport Upgrade a QUIC connection into a WebTransport instance. f Deno.utime Changes the access (`atime`) and modification (`mtime`) times of a file system 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`) times of a file system object referenced by `path`. Given times are either in seconds (UNIX epoch time) or as `Date` objects. f Deno.watchFs Watch for file system events against one or more `paths`, which can be files 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 if needed, else overwriting. f Deno.writeFileSync Synchronously write `data` to the given `path`, by default creating a new file if needed, else overwriting. f Deno.writeTextFile Write string `data` to the given `path`, by default creating a new file if needed, else overwriting. f Deno.writeTextFileSync Synchronously write string `data` to the given `path`, by default creating a new file if needed, else overwriting. ### Interfaces # I Deno.AtomicCheck A check to perform as part of a `Deno.AtomicOperation`. The check will fail if the versionstamp for the key-value pair in the KV store does not match the given versionstamp. A check with a `null` versionstamp checks that the key-value pair does not currently exist in the KV store. * key * versionstamp I Deno.BasicAuth Basic authentication credentials to be used with a `Deno.Proxy` server when specifying `Deno.CreateHttpClientOptions`. * password * username I Deno.BenchContext Context that is passed to a benchmarked function. The instance is shared between iterations of the benchmark. Its methods can be used for example to override of the measured portion of the function. * end * name * origin * start I Deno.BenchDefinition The interface for defining a benchmark test using `Deno.bench`. * baseline * fn * group * ignore * n * name * only * permissions * sanitizeExit * warmup I Deno.CaaRecord If `Deno.resolveDns` is called with `"CAA"` record type specified, it will resolve with an array of objects with this interface. * critical * tag * value I Deno.CommandOptions Options which can be set when calling `Deno.Command`. * args * clearEnv * cwd * env * gid * signal * stderr * stdin * stdout * uid * windowsRawArguments I Deno.CommandOutput The interface returned from calling `Deno.Command.output` or `Deno.Command.outputSync` which represents the result of spawning the child process. * stderr * stdout I Deno.CommandStatus No documentation available * code * signal * success I Deno.Conn No documentation available * close * closeWrite * localAddr * read * readable * ref * remoteAddr * unref * writable * write I Deno.ConnectOptions No documentation available * hostname * port * transport I Deno.ConnectQuicOptions No documentation available * alpnProtocols * caCerts * endpoint * hostname * port * serverName * zeroRtt I Deno.ConnectTlsOptions No documentation available * alpnProtocols * caCerts * hostname * port I Deno.CreateHttpClientOptions The options used when creating a `Deno.HttpClient`. * allowHost * caCerts * http1 * http2 * poolIdleTimeout * poolMaxIdlePerHost * proxy I Deno.CronSchedule CronSchedule is the interface used for JSON format cron `schedule`. * dayOfMonth * dayOfWeek * hour * minute * month I Deno.DatagramConn A generic transport listener for message-oriented protocols. * addr * close * joinMulticastV4 * joinMulticastV6 * receive * send I Deno.DenoTest No documentation available * ignore * only I Deno.DirEntry Information about a directory entry returned from `Deno.readDir` and `Deno.readDirSync`. * isDirectory * isFile * isSymlink * name I Deno.DynamicLibrary A dynamic library resource. Use `Deno.dlopen` to load a dynamic library and return this interface. * close * symbols I Deno.Env An interface containing methods to interact with the process environment variables. * delete * get * has * set * toObject I Deno.EnvPermissionDescriptor The permission descriptor for the `allow-env` and `deny-env` permissions, which controls access to being able to read and write to the process environment variables as well as access other information about the environment. The option `variable` allows scoping the permission to a specific environment variable. * name * variable I Deno.FfiPermissionDescriptor The permission descriptor for the `allow-ffi` and `deny-ffi` permissions, which controls access to loading _foreign_ code and interfacing with it via the Foreign Function Interface API available in Deno. The option `path` allows scoping the permission to a specific path on the host. * name * path I Deno.FileInfo Provides information about a file and is returned by `Deno.stat`, `Deno.lstat`, `Deno.statSync`, and `Deno.lstatSync` or from calling `stat()` and `statSync()` on an `Deno.FsFile` instance. * atime * birthtime * blksize * blocks * ctime * dev * gid * ino * isBlockDevice * isCharDevice * isDirectory * isFifo * isFile * isSocket * isSymlink * mode * mtime * nlink * rdev * size * uid I Deno.ForeignFunction The interface for a foreign function as defined by its parameter and result types. * name * nonblocking * optional * parameters * result I Deno.ForeignLibraryInterface A foreign library interface descriptor. I Deno.ForeignStatic No documentation available * name * optional * type I Deno.FsEvent Represents a unique file system event yielded by a `Deno.FsWatcher`. * flag * kind * paths I Deno.FsWatcher Returned by `Deno.watchFs`. It is an async iterator yielding up system events. To stop watching the file system by calling `.close()` method. * close * return I Deno.HttpServer An instance of the server created using `Deno.serve()` API. * addr * finished * ref * shutdown * unref I Deno.InspectOptions Option which can be specified when performing `Deno.inspect`. * breakLength * colors * compact * depth * escapeSequences * getters * iterableLimit * showHidden * showProxy * sorted * strAbbreviateSize * trailingComma I Deno.KvCommitError No documentation available * ok I Deno.KvCommitResult No documentation available * ok * versionstamp I Deno.KvEntry A versioned pair of key and value in a `Deno.Kv`. * key * value * versionstamp I Deno.KvListOptions Options for listing key-value pairs in a `Deno.Kv`. * batchSize * consistency * cursor * limit * reverse I Deno.Listener A generic network listener for stream-oriented protocols. * accept * addr * close * ref * unref I Deno.ListenOptions No documentation available * hostname * port I Deno.ListenTlsOptions No documentation available * alpnProtocols * transport I Deno.MakeTempOptions Options which can be set when using `Deno.makeTempDir`, `Deno.makeTempDirSync`, `Deno.makeTempFile`, and `Deno.makeTempFileSync`. * dir * prefix * suffix I Deno.MemoryUsage No documentation available * external * heapTotal * heapUsed * rss I Deno.MkdirOptions Options which can be set when using `Deno.mkdir` and `Deno.mkdirSync`. * mode * recursive I Deno.MulticastV4Membership Represents membership of a IPv4 multicast group. * leave * setLoopback * setTTL I Deno.MulticastV6Membership Represents membership of a IPv6 multicast group. * leave * setLoopback I Deno.MxRecord If `Deno.resolveDns` is called with `"MX"` record type specified, it will return an array of objects with this interface. * exchange * preference I Deno.NaptrRecord If `Deno.resolveDns` is called with `"NAPTR"` record type specified, it will return an array of objects with this interface. * flags * order * preference * regexp * replacement * services I Deno.NativeStructType The native struct type for interfacing with foreign functions. * struct I Deno.NetAddr No documentation available * hostname * port * transport I Deno.NetPermissionDescriptor The permission descriptor for the `allow-net` and `deny-net` permissions, which controls access to opening network ports and connecting to remote hosts via the network. The option `host` allows scoping the permission for outbound connection to a specific host and port. * host * name I Deno.NetworkInterfaceInfo The information for a network interface returned from a call to `Deno.networkInterfaces`. * address * cidr * family * mac * name * netmask * scopeid I Deno.OpenOptions Options which can be set when doing `Deno.open` and `Deno.openSync`. * append * create * createNew * mode * read * truncate * write I Deno.PermissionOptionsObject A set of options which can define the permissions within a test or worker context at a highly specific level. * env * ffi * import * net * read * run * sys * write I Deno.PermissionStatusEventMap The interface which defines what event types are supported by `PermissionStatus` instances. * change I Deno.PointerObject A non-null pointer, represented as an object at runtime. The object's prototype is `null` and cannot be changed. The object cannot be assigned to either and is thus entirely read-only. * brand I Deno.Proxy The definition of a proxy when specifying `Deno.CreateHttpClientOptions`. * basicAuth * url I Deno.QuicAcceptOptions No documentation available * alpnProtocols * zeroRtt I Deno.QuicBidirectionalStream No documentation available * readable * writable I Deno.QuicCloseInfo No documentation available * closeCode * reason I Deno.QuicConn No documentation available * close * closed * createBidirectionalStream * createUnidirectionalStream * endpoint * handshake * incomingBidirectionalStreams * incomingUnidirectionalStreams * maxDatagramSize * protocol * readDatagram * remoteAddr * sendDatagram * serverName I Deno.QuicEndpointOptions No documentation available * hostname * port I Deno.QuicIncoming An incoming connection for which the server has not yet begun its part of the handshake. * accept * ignore * localIp * refuse * remoteAddr * remoteAddressValidated I Deno.QuicListener Specialized listener that accepts QUIC connections. * accept * endpoint * incoming * stop I Deno.QuicListenOptions No documentation available * alpnProtocols * cert * key I Deno.QuicReceiveStream No documentation available * id I Deno.QuicSendStream No documentation available * id * sendOrder I Deno.QuicSendStreamOptions No documentation available * sendOrder * waitUntilAvailable I Deno.QuicServerTransportOptions No documentation available * preferredAddressV4 * preferredAddressV6 I Deno.QuicTransportOptions No documentation available * congestionControl * keepAliveInterval * maxConcurrentBidirectionalStreams * maxConcurrentUnidirectionalStreams * maxIdleTimeout I Deno.ReadFileOptions Options which can be set when using `Deno.readFile` or `Deno.readFileSync`. * signal I Deno.ReadPermissionDescriptor The permission descriptor for the `allow-read` and `deny-read` permissions, which controls access to reading resources from the local host. The option `path` allows scoping the permission to a specific path (and if the path is a directory any sub paths). * name * path I Deno.RemoveOptions Options which can be set when using `Deno.remove` and `Deno.removeSync`. * recursive I Deno.ResolveDnsOptions Options which can be set when using `Deno.resolveDns`. * nameServer * signal I Deno.RunPermissionDescriptor The permission descriptor for the `allow-run` and `deny-run` permissions, which controls access to what sub-processes can be executed by Deno. The option `command` allows scoping the permission to a specific executable. * command * name I Deno.ServeDefaultExport Interface that module run with `deno serve` subcommand must conform to. * fetch I Deno.ServeHandlerInfo Additional information for an HTTP request and its connection. * completed * remoteAddr I Deno.ServeInit No documentation available * handler I Deno.ServeOptions Options which can be set when calling `Deno.serve`. * onError * onListen * signal I Deno.ServeTcpOptions Options that can be passed to `Deno.serve` to create a server listening on a TCP port. * hostname * port * reusePort * transport I Deno.ServeUnixOptions Options that can be passed to `Deno.serve` to create a server listening on a Unix domain socket. * path * transport I Deno.SetRawOptions No documentation available * cbreak I Deno.SoaRecord If `Deno.resolveDns` is called with `"SOA"` record type specified, it will return an array of objects with this interface. * expire * minimum * mname * refresh * retry * rname * serial I Deno.SrvRecord If `Deno.resolveDns` is called with `"SRV"` record type specified, it will return an array of objects with this interface. * port * priority * target * weight I Deno.StartTlsOptions No documentation available * alpnProtocols * caCerts * hostname I Deno.SymlinkOptions Options that can be used with `symlink` and `symlinkSync`. * type I Deno.SysPermissionDescriptor The permission descriptor for the `allow-sys` and `deny-sys` permissions, which controls access to sensitive host system information, which malicious code might attempt to exploit. The option `kind` allows scoping the permission to a specific piece of information. * kind * name I Deno.SystemMemoryInfo Information returned from a call to `Deno.systemMemoryInfo`. * available * buffers * cached * free * swapFree * swapTotal * total I Deno.TcpConn No documentation available * setKeepAlive * setNoDelay I Deno.TcpListenOptions No documentation available * reusePort I Deno.TestContext Context that is passed to a testing function, which can be used to either gain information about the current test, or register additional test steps within the current test. * name * origin * parent * step I Deno.TestDefinition No documentation available * fn * ignore * name * only * permissions * sanitizeExit * sanitizeOps * sanitizeResources I Deno.TestStepDefinition No documentation available * fn * ignore * name * sanitizeExit * sanitizeOps * sanitizeResources I Deno.TlsCertifiedKeyPem Provides certified key material from strings. The key material is provided in `PEM`\-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 compatible with `DER`\-format keys which are binary. * cert * key * keyFormat I Deno.TlsConn No documentation available * handshake I Deno.TlsHandshakeInfo No documentation available * alpnProtocol I Deno.UdpListenOptions Unstable options which can be set when opening a datagram listener via `Deno.listenDatagram`. * loopback * reuseAddress I Deno.UnixAddr No documentation available * path * transport I Deno.UnixConn No documentation available I Deno.UnixConnectOptions No documentation available * path * transport I Deno.UnixListenOptions Options which can be set when opening a Unix listener via `Deno.listen` or `Deno.listenDatagram`. * path I Deno.UnsafeCallbackDefinition Definition of a unsafe callback function. * parameters * result I Deno.UpgradeWebSocketOptions Options which can be set when performing a `Deno.upgradeWebSocket` upgrade of a `Request` * idleTimeout * protocol I Deno.WebSocketUpgrade The object that is returned from a `Deno.upgradeWebSocket` request. * response * socket I Deno.WriteFileOptions Options for writing to a file. * append * create * createNew * mode * signal I Deno.WritePermissionDescriptor The permission descriptor for the `allow-write` and `deny-write` permissions, which controls access to writing to resources from the local host. The option `path` allow scoping the permission to a specific path (and if the path is a directory any sub paths). * name * path I Deno.OpMetrics No documentation available * bytesReceived * bytesSentControl * bytesSentData * opsCompleted * opsCompletedAsync * opsCompletedAsyncUnref * opsCompletedSync * opsDispatched * opsDispatchedAsync * opsDispatchedAsyncUnref * opsDispatchedSync ### 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. N Deno.lint No documentation available N Deno.telemetry APIs for working with the OpenTelemetry observability framework. Deno can export traces, metrics, and logs to OpenTelemetry compatible backends via the OTLP protocol. ### 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 callback parameters. 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 sequence of `Deno.KvKeyPart`s. T Deno.KvKeyPart A single part of a `Deno.KvKey`. Parts are ordered lexicographically, first by their type, and within a given type by their value. T Deno.KvListSelector A selector that selects the range of data returned by a list operation on a `Deno.Kv`. T Deno.KvMutation A mutation to a key in a `Deno.Kv`. A mutation is a combination of a key, a value, and a type. The type determines how the mutation 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 `PointerObject` object or a `null` if the pointer is null. T Deno.RecordType The type of the resource record to resolve via DNS using `Deno.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. What signals 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 return types. 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. * arch * env * os * target * vendor v Deno.env An interface containing methods to interact with the process environment variables. v Deno.exitCode The exit code for the Deno process. v Deno.mainModule The URL of the entrypoint module entered from the command-line. It requires 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 specific `Writer`, `WriterSync`, and `Closer` interfaces as well as provides a `WritableStream` interface. * close * isTerminal * writable * write * writeSync v Deno.stdin A reference to `stdin` which can be used to read directly from `stdin`. * close * isTerminal * read * readSync * readable * setRaw v Deno.stdout A reference to `stdout` which can be used to write directly to `stdout`. It implements the Deno specific `Writer`, `WriterSync`, and `Closer` interfaces as well as provides a `WritableStream` interface. * close * isTerminal * writable * write * writeSync v Deno.test Register a test which will be run when `deno test` is used on the command line and the containing module looks like a test module. v Deno.version Version information related to the current Deno CLI runtime environment. * deno * typescript * v8