Class Decrypt

Decrypt

Date

1/31/2024 - 6:36:57 PM

Export

Constructors

constructor

new Decrypt(params): Decrypt
Creates an instance of Decrypt.
Parameters
- params: CryptoConfig
Returns Decrypt
Date
1/31/2024 - 3:59:10 PM
- Defined in src/crypto/decrypt.ts:38

Properties

`Private` `Readonly` config

config: CryptoConfig

`Private` `Readonly` textDecoder

textDecoder: TextDecoder = ...

Methods

chatConversationName

chatConversationName(param0): Promise<string>
Decrypt a chat conversation name.
Parameters
- param0: {
  key: string;
  name: string;
  }
  - key: string
  - name: string
Returns Promise<string>
Date
2/20/2024 - 5:31:41 AM

Async
- Defined in src/crypto/decrypt.ts:839

chatKeyOwner

chatKeyOwner(param0): Promise<string>
Decrypts a chat encryption (symmetric) key.
Parameters
- param0: {
  key?: string;
  metadata: string;
  }
  - Optional key?: string
  - metadata: string
Returns Promise<string>
Async
- Defined in src/crypto/decrypt.ts:545

chatKeyParticipant

chatKeyParticipant(param0): Promise<string>
Decrypts a chat encryption (symmetric) key.
Parameters
- param0: {
  metadata: string;
  privateKey: string;
  }
  - metadata: string
  - privateKey: string
Returns Promise<string>
Date
2/6/2024 - 12:54:25 AM

Async
- Defined in src/crypto/decrypt.ts:510

chatMessage

chatMessage(param0): Promise<string>
Decrypt a chat message
Parameters
- param0: {
  key: string;
  message: string;
  }
  - key: string
  - message: string
Returns Promise<string>
Date
2/20/2024 - 5:34:42 AM

Async
- Defined in src/crypto/decrypt.ts:598

data

data(param0): Promise<Buffer>
Decrypt data.
Parameters
- param0: {
      data: Buffer;
      key: string;
      version: FileEncryptionVersion;
  }
  - data: Buffer
  - key: string
  - version: FileEncryptionVersion
Returns Promise<Buffer>
Date
2/7/2024 - 1:50:58 AM

Async
- Defined in src/crypto/decrypt.ts:876

dataStream

dataStream(param0): Promise<string>
Decrypt a file/chunk using streams. Only available in a Node.JS environment.
Parameters
- param0: {
      inputFile: string;
      key: string;
      outputFile?: string;
      version: FileEncryptionVersion;
  }
  - inputFile: string
  - key: string
  - Optional outputFile?: string
  - version: FileEncryptionVersion
Returns Promise<string>
Date
2/7/2024 - 1:38:12 AM

Async
- Defined in src/crypto/decrypt.ts:1061

event

event(param0): Promise<UserEvent>
Decrypt a user event.
Parameters
- param0: {
  event: UserEvent;
  }
  - event: UserEvent
Returns Promise<UserEvent>
Async
- Defined in src/crypto/decrypt.ts:1234

fileMetadata

fileMetadata(param0): Promise<FileMetadata>
Decrypt file metadata.
Parameters
- param0: {
  key?: string;
  metadata: string;
  }
  - Optional key?: string
  - metadata: string
Returns Promise<FileMetadata>
Date
2/3/2024 - 1:54:51 AM

Async
- Defined in src/crypto/decrypt.ts:161

fileMetadataLink

fileMetadataLink(param0): Promise<FileMetadata>
Decrypt file metadata inside a public link.
Parameters
- param0: {
  linkKey: string;
  metadata: string;
  }
  - linkKey: string
  - metadata: string
Returns Promise<FileMetadata>
Date
2/6/2024 - 3:05:42 AM

Async
- Defined in src/crypto/decrypt.ts:375

fileMetadataPrivate

fileMetadataPrivate(param0): Promise<FileMetadata>
Decrypt file metadata using a private key.
Parameters
- param0: {
  key?: string;
  metadata: string;
  }
  - Optional key?: string
  - metadata: string
Returns Promise<FileMetadata>
Date
2/3/2024 - 1:58:12 AM

Async
- Defined in src/crypto/decrypt.ts:275

folderLinkKey

folderLinkKey(param0): Promise<string>
Decrypt a public link folder encryption key (using given key or master keys).
Parameters
- param0: {
  key?: string;
  metadata: string;
  }
  - Optional key?: string
  - metadata: string
Returns Promise<string>
Date
2/6/2024 - 3:09:37 AM

Async
- Defined in src/crypto/decrypt.ts:471

folderMetadata

folderMetadata(param0): Promise<FolderMetadata>
Decrypt folder metadata.
Parameters
- param0: {
  key?: string;
  metadata: string;
  }
  - Optional key?: string
  - metadata: string
Returns Promise<FolderMetadata>
Date
2/3/2024 - 1:55:17 AM

Async
- Defined in src/crypto/decrypt.ts:222

folderMetadataLink

folderMetadataLink(param0): Promise<FolderMetadata>
Decrypt folder metadata inside a public link.
Parameters
- param0: {
  linkKey: string;
  metadata: string;
  }
  - linkKey: string
  - metadata: string
Returns Promise<FolderMetadata>
Date
2/6/2024 - 3:07:06 AM

Async
- Defined in src/crypto/decrypt.ts:430

folderMetadataPrivate

folderMetadataPrivate(param0): Promise<FolderMetadata>
Decrypt folder metadata using a private key.
Parameters
- param0: {
  key?: string;
  metadata: string;
  }
  - Optional key?: string
  - metadata: string
Returns Promise<FolderMetadata>
Date
2/3/2024 - 1:58:05 AM

Async
- Defined in src/crypto/decrypt.ts:332

metadata

metadata(param0): Promise<string>
Decrypt a string with the given key.
Parameters
- param0: {
  key: string;
  metadata: string;
  }
  - key: string
  - metadata: string
Returns Promise<string>
Date
1/31/2024 - 3:58:27 PM

Async
- Defined in src/crypto/decrypt.ts:53

metadataPrivate

metadataPrivate(param0): Promise<string>
Decrypt metadata using the given private key.
Parameters
- param0: {
  metadata: string;
  privateKey: string;
  }
  - metadata: string
  - privateKey: string
Returns Promise<string>
Date
2/3/2024 - 1:50:10 AM

Async
- Defined in src/crypto/decrypt.ts:117

noteContent

noteContent(param0): Promise<string>
Decrypt note content using the note's symmetric encryption key.
Parameters
- param0: {
  content: string;
  key: string;
  }
  - content: string
  - key: string
Returns Promise<string>
Date
2/6/2024 - 2:50:15 AM

Async
- Defined in src/crypto/decrypt.ts:699

noteKeyOwner

noteKeyOwner(param0): Promise<string>
Decrypts the symmetric note encryption key with the given owner metadata.
Parameters
- param0: {
  key?: string;
  metadata: string;
  }
  - Optional key?: string
  - metadata: string
Returns Promise<string>
Date
2/6/2024 - 1:01:59 AM

Async
- Defined in src/crypto/decrypt.ts:624

noteKeyParticipant

noteKeyParticipant(param0): Promise<string>
Decrypt a symmetric note encryption key using participant metadata and their private key.
Parameters
- param0: {
  metadata: string;
  privateKey: string;
  }
  - metadata: string
  - privateKey: string
Returns Promise<string>
Date
2/6/2024 - 2:47:34 AM

Async
- Defined in src/crypto/decrypt.ts:663

notePreview

notePreview(param0): Promise<string>
Decrypt a note's preview using the note's symmetric encryption key.
Parameters
- param0: {
  key: string;
  preview: string;
  }
  - key: string
  - preview: string
Returns Promise<string>
Date
2/6/2024 - 2:53:35 AM

Async
- Defined in src/crypto/decrypt.ts:761

noteTagName

noteTagName(param0): Promise<string>
Decrypt a note tag name using the master keys or a given key.
Parameters
- param0: {
  key?: string;
  name: string;
  }
  - Optional key?: string
  - name: string
Returns Promise<string>
Date
2/6/2024 - 2:56:38 AM

Async
- Defined in src/crypto/decrypt.ts:797

noteTitle

noteTitle(param0): Promise<string>
Decrypt a note's title using the note's symmetric encryption key.
Parameters
- param0: {
  key: string;
  title: string;
  }
  - key: string
  - title: string
Returns Promise<string>
Date
2/6/2024 - 2:52:02 AM

Async
- Defined in src/crypto/decrypt.ts:725

Class Decrypt

Date

Export

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

params: CryptoConfig

Returns Decrypt

Date

Properties

Private Readonly config

Private Readonly textDecoder

Methods

chatConversationName

Parameters

param0: { key: string; name: string; }

key: string

name: string

Returns Promise<string>

Date

Async

chatKeyOwner

Parameters

param0: { key?: string; metadata: string; }

Optional key?: string

metadata: string

Returns Promise<string>

Async

chatKeyParticipant

Parameters

param0: { metadata: string; privateKey: string; }

metadata: string

privateKey: string

Returns Promise<string>

Date

Async

chatMessage

Parameters

param0: { key: string; message: string; }

key: string

message: string

Returns Promise<string>

Date

Async

data

Parameters

param0: { data: Buffer; key: string; version: FileEncryptionVersion; }

data: Buffer

key: string

version: FileEncryptionVersion

Returns Promise<Buffer>

Date

Async

dataStream

Parameters

param0: { inputFile: string; key: string; outputFile?: string; version: FileEncryptionVersion; }

inputFile: string

key: string

Optional outputFile?: string

version: FileEncryptionVersion

Returns Promise<string>

Date

Async

event

Parameters

param0: { event: UserEvent; }

event: UserEvent

Returns Promise<UserEvent>

Async

fileMetadata

Parameters

param0: { key?: string; metadata: string; }

Optional key?: string

metadata: string

Returns Promise<FileMetadata>

Date

`Private` `Readonly` config

`Private` `Readonly` textDecoder

param0: {
key: string;
name: string;
}

param0: {
key?: string;
metadata: string;
}

`Optional` key?: string

param0: {
metadata: string;
privateKey: string;
}

param0: {
key: string;
message: string;
}

param0: {
data: Buffer;
key: string;
version: FileEncryptionVersion;
}

param0: {
inputFile: string;
key: string;
outputFile?: string;
version: FileEncryptionVersion;
}

`Optional` outputFile?: string

param0: {
event: UserEvent;
}

param0: {
key?: string;
metadata: string;
}

`Optional` key?: string

param0: {
linkKey: string;
metadata: string;
}

param0: {
key?: string;
metadata: string;
}

`Optional` key?: string

param0: {
key?: string;
metadata: string;
}

`Optional` key?: string

param0: {
key?: string;
metadata: string;
}

`Optional` key?: string

param0: {
linkKey: string;
metadata: string;
}

param0: {
key?: string;
metadata: string;
}

`Optional` key?: string

param0: {
key: string;
metadata: string;
}

param0: {
metadata: string;
privateKey: string;
}

param0: {
content: string;
key: string;
}