Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace <internal>

Index

Type aliases

AppInfo: { creator: string; name: string }

Type declaration

  • creator: string
  • name: string
BareNameFilter: Opaque<"BareNameFilter", string>
ConstructorParams: { localOnly?: boolean; permissions?: Permissions; root: <internal>.default }

Type declaration

ConstructorParams: { header: PrivateTreeInfo; key: string; mmpt: <internal>.default }

Type declaration

ConstructorParams: { cid: Maybe<CID>; header: TreeHeader; links: Links }

Type declaration

ConstructorParams: { content: FileContent; header: PrivateFileInfo; key: string; mmpt: <internal>.default }

Type declaration

ConstructorParams: { cid: Maybe<CID>; content: FileContent; header: FileHeader }

Type declaration

Endpoints: { api: string; apiUrl: string | null; apiVersion: string; lobby: string; user: string }

Type declaration

  • api: string
  • apiUrl: string | null
  • apiVersion: string
  • lobby: string
  • user: string
FileHeader: { metadata: Metadata; previous?: CID | string }

Type declaration

  • metadata: Metadata
  • Optional previous?: CID | string
FileInfo: FileHeader & { userland: CID | string }
FileSystemOptions: { localOnly?: boolean; permissions?: Permissions }

Type declaration

  • Optional localOnly?: boolean
  • Optional permissions?: Permissions
FileSystemPermissions: { private?: DistinctivePath[]; public?: DistinctivePath[] }

Type declaration

Implementation: { init: any; isUsernameAvailable: any; isUsernameValid: any; register: any }

Type declaration

  • init:function
  • isUsernameAvailable:function
    • isUsernameAvailable(username: string): Promise<boolean>
  • isUsernameValid:function
    • isUsernameValid(username: string): Promise<boolean>
  • register:function
    • register(options: { email: string; username: string }): Promise<{ success: boolean }>
    • Parameters

      • options: { email: string; username: string }
        • email: string
        • username: string

      Returns Promise<{ success: boolean }>

Implementation: { ed25519: { verify: any }; keystore: { clear: any; decrypt: any; exportSymmKey: any; getAlg: any; importSymmKey: any; keyExists: any; publicExchangeKey: any; publicWriteKey: any; sign: any }; rsa: { verify: any } }

Type declaration

  • ed25519: { verify: any }
    • verify:function
      • verify(message: Uint8Array, signature: Uint8Array, publicKey: Uint8Array): Promise<boolean>
  • keystore: { clear: any; decrypt: any; exportSymmKey: any; getAlg: any; importSymmKey: any; keyExists: any; publicExchangeKey: any; publicWriteKey: any; sign: any }
  • rsa: { verify: any }
    • verify:function
      • verify(message: Uint8Array, signature: Uint8Array, publicKey: Uint8Array): Promise<boolean>
Implementation: { clear: any; getItem: any; removeItem: any; setItem: any }

Type declaration

Member: { cid: CID; name: string }

Type declaration

  • cid: CID
  • name: string
Metadata: { isFile: boolean; unixMeta: UnixMeta; version: SemVer }

Type declaration

MutationOptions: { publish?: boolean }

Type declaration

  • Optional publish?: boolean
NewFileSystemOptions: FileSystemOptions & { rootKey?: string }
Node: { constructor: { fromInfo: any }; header: { bareNameFilter: BareNameFilter; metadata: Metadata; revision: number }; key: string; mmpt: <internal>.default }

Type declaration

Node: { constructor: { fromCID: any }; header: { metadata: Metadata; previous: CID } }

Type declaration

NonEmptyPath: [string, ...string[]]
Permissions: { app?: AppInfo; fs?: FileSystemPermissions; platform?: PlatformPermissions; raw?: RawPermissions; sharing?: boolean }

Type declaration

PlatformPermissions: { apps: "*" | string[] }

Type declaration

  • apps: "*" | string[]
PrivateAddResult: AddResult & { key: string; name: PrivateName; skeleton: PrivateSkeleton }
PrivateFileInfo: { bareNameFilter: BareNameFilter; content: CID | string; key: string; metadata: Metadata; revision: number }

Type declaration

PrivateLink: BaseLink & { key: string; pointer: PrivateName }
PrivateLinks: {}

Type declaration

PrivateName: Opaque<"PrivateName", string>
PrivateSkeleton: {}

Type declaration

PrivateSkeletonInfo: { cid: CID | string; key: string; subSkeleton: PrivateSkeleton }

Type declaration

PrivateTreeInfo: { bareNameFilter: BareNameFilter; links: PrivateLinks; metadata: Metadata; revision: number; skeleton: PrivateSkeleton }

Type declaration

PublishHook: (result: CID, proof: string) => unknown

Type declaration

    • (result: CID, proof: string): unknown
    • Parameters

      • result: CID
      • proof: string

      Returns unknown

PutDetails: AddResult & { isFile: boolean; metadata: CID; skeleton: Skeleton; userland: CID }
RawPermission: { exp: number; ptc: Potency; rsc: Resource }

Type declaration

RawPermissions: RawPermission[]
Revision: { cid: CID | string; name: PrivateName; number: number }

Type declaration

SemVer: { major: number; minor: number; patch: number }

Type declaration

  • major: number
  • minor: number
  • patch: number
ShareDetails: { shareId: string; sharedBy: SharedBy }

Type declaration

SharedBy: { rootDid: string; username: string }

Type declaration

  • rootDid: string
  • username: string
Skeleton: {}

Type declaration

SkeletonInfo: { cid: CID | string; isFile: boolean; metadata: CID | string; subSkeleton: Skeleton; userland: CID | string }

Type declaration

  • cid: CID | string
  • isFile: boolean
  • metadata: CID | string
  • subSkeleton: Skeleton
  • userland: CID | string
TreeHeader: { metadata: Metadata; previous?: CID | string; skeleton: Skeleton }

Type declaration

TreeInfo: TreeHeader & { userland: CID | string }
UnixFileMode: number
UnixMeta: { _type: string; ctime: number; mode: UnixFileMode; mtime: number }

Type declaration

UpdateCallback: () => Promise<unknown>

Type declaration

    • (): Promise<unknown>
    • Returns Promise<unknown>

UserMessages: { versionMismatch: { newer: any; older: any } }

Type declaration

  • versionMismatch: { newer: any; older: any }
    • newer:function
      • newer(version: string): Promise<void>
    • older:function
      • older(version: string): Promise<void>

Generated using TypeDoc