Hi there! Are you looking for the official Deno documentation? Try docs.deno.com for all your Deno learning needs.

§Namespaces

apps
Auth
Capabilities
Crypto
Depot
did
fission
Manners
path
Reference
Storage
ucan

§Classes

CID
FileSystem
Session

§Enums

Crypto.SymmAlg
path.Kind
path.RootBranch
ProgramError

§Variables

auth

Predefined auth configurations.

capabilities

Predefined capabilities configurations.

compositions

Full component sets.

crypto

Predefined crypto configurations.

depot

Predefined depot configurations.

EMPTY_CID

CID representing an empty string. We use this to speed up DNS propagation However, we treat that as a null value in the code

fission.PRODUCTION
fission.STAGING
manners

Predefined manners configurations.

reference

Predefined reference configurations.

ROOT_FILESYSTEM_PERMISSIONS
storage

Predefined storage configuration.

VERSION
WASM_WNFS_VERSION

§Functions

addRootFileSystemPermissions
appId

App identifier.

apps.create

Creates a new app, assigns an initial subdomain, and sets an asset placeholder

apps.deleteByDomain

Destroy app by any associated domain

apps.index

Get A list of all of your apps and their associated domain names

apps.publish

Updates an app by CID

assemble

Build a Webnative Program based on a given set of Components. These are various customisable components that determine how a Webnative app works. Use program to work with a default, or partial, set of components.

decodeCID

Decode a possibly string-encoded CID. Passing an already decoded CID instance works too.

defaultAuthComponent
defaultCapabilitiesComponent
defaultCryptoComponent
defaultDepotComponent
defaultMannersComponent
defaultReferenceComponent
defaultStorageComponent
did.agent

Create a DID based on the write key-pair.

did.didToPublicKey

Convert a DID (did:key) to a base64 public key.

did.exchange

Create a DID based on the exchange key-pair.

did.publicKeyToDid

Convert a base64 public key to a DID (did:key).

did.sharing

Create a DID based on the exchange key-pair.

did.ucan

Create a DID based on the write key-pair.

did.write

Create a DID based on the write key-pair.

encodeCID

Encode a CID as a string.

extractConfig
fission.apiUrl
fission.did

Lookup the DID of a Fission API. This function caches the DID for 3 hours.

fission.shareLink

Create a share link. There people can "accept" a share, copying the soft links into their private filesystem.

gatherComponents
isCapabilityBasedAuthConfiguration

Is this a configuration that uses capabilities?

isSupported

Is this browser supported?

namespace

Generate a namespace string based on a configuration.

path.appData

Utility function create an app data path.

path.combine

Combine two DistinctivePaths.

path.directory

Utility function to create a DirectoryPath

path.file

Utility function to create a FilePath

path.fromPosix

Transform a string into a DistinctivePath.

path.isDirectory

Is this DistinctivePath a directory?

path.isFile

Is this DistinctivePath a file?

path.isOnRootBranch

Is this DistinctivePath on the given RootBranch?

path.isPartition

Is this DistinctivePath of the given Partition?

path.isRootDirectory

Is this DirectoryPath a root directory?

path.isSameKind

Check if two DistinctivePath are of the same kind.

path.isSamePartition

Check if two DistinctivePath have the same Partition.

path.kind

What Kind of path are we dealing with?

path.log

Render a raw Path to a string for logging purposes.

path.map

Map a DistinctivePath.

path.parent

Get the parent directory of a DistinctivePath.

path.removePartition

Remove the Partition of a DistinctivePath (ie. the top-level directory)

path.root

Utility function to create a root DirectoryPath

path.terminus

Get the last part of the path.

path.toPosix

Transform a DistinctivePath into a string.

path.unwrap

Unwrap a DistinctivePath.

path.withPartition

Utility function to prefix a path with a Partition.

permissionPaths

Lists the filesystems paths for a set of Permissions. This'll return a list of DistinctivePaths.

program

🚀 Build a webnative program.

ucan.build

Create a UCAN, User Controlled Authorization Networks, JWT. This JWT can be used for authorization.

ucan.decode

Try to decode a UCAN. Will throw if it fails.

ucan.encode

Encode a UCAN.

ucan.encodeHeader

Encode the header of a UCAN.

ucan.encodePayload

Encode the payload of a UCAN.

ucan.isExpired

Check if a UCAN is expired.

ucan.isSelfSigned

Check if a UCAN is self-signed.

ucan.isValid

Check if a UCAN is valid.

ucan.rootIssuer

Given a UCAN, lookup the root issuer.

ucan.sign

Generate UCAN signature.

§Type Aliases

AccountLinkingConsumer
AccountLinkingProducer
AppInfo

Information about your app.

apps.AppMetadata
apps.Dependencies
Auth.Implementation
AuthenticationStrategy
Capabilities.Implementation
Capabilities.RequestOptions
Components
Configuration
Crypto.Implementation
Crypto.ImplementationOptions
Crypto.VerifyArgs
Depot.DirectoryItem
Depot.Implementation
Depot.PutResult
FileSystemPermissions
FileSystemShortHands
fission.Endpoints

Fission endpoints.

Manners.DataComponents
Manners.Implementation
Manners.ImplementationOptions
Maybe
Opaque
path.Directory

Alias for DirectoryPath

path.DirectoryPath

A directory path.

path.Distinctive

Alias for DistinctivePath

path.DistinctivePath

A file or directory path.

path.File

Alias for FilePath

path.FilePath

A file path.

path.Partition

RootBranches that are accessible through the POSIX file system interface.

path.Partitioned
path.PartitionedNonEmpty
path.Private

Private partition

path.Public

Public partition

path.Segment
path.Segments
path.SegmentsNonEmpty
Permissions
PlatformPermissions
Program
RawPermission
RawPermissions
Reference.Implementation
Result
ShortHands
Storage.Implementation
Storage.ImplementationOptions
ucan.Fact
ucan.Potency
ucan.Resource
ucan.SessionKey
ucan.Ucan
ucan.UcanHeader
ucan.UcanPayload
UserMessages