Class Encrypt

Encrypt

Date

2/1/2024 - 2:44:28 AM

Export

Index

Constructors

Properties

config textEncoder

Methods

chatConversationName chatMessage data dataStream metadata metadataPublic noteContent notePreview noteTagName noteTitle

Constructors

constructor

new Encrypt(params): Encrypt
Creates an instance of Encrypt.
Parameters
- params: CryptoConfig
Returns Encrypt
Date
1/31/2024 - 3:59:21 PM
- Defined in src/crypto/encrypt.ts:33

Properties

`Private` `Readonly` config

config: CryptoConfig

`Private` `Readonly` textEncoder

textEncoder: TextEncoder = ...

Methods

chatConversationName

chatConversationName(param0): Promise<string>
Encrypt the conversation name using the conversation encryption key.
Parameters
- param0: {
  key: string;
  name: string;
  }
  - key: string
  - name: string
Returns Promise<string>
Date
2/6/2024 - 3:03:45 AM

Async
- Defined in src/crypto/encrypt.ts:249

chatMessage

chatMessage(param0): Promise<string>
Encrypt a chat message using the conversation encryption key.
Parameters
- param0: {
  key: string;
  message: string;
  }
  - key: string
  - message: string
Returns Promise<string>
Date
2/6/2024 - 3:01:09 AM

Async
- Defined in src/crypto/encrypt.ts:152

data

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

Async
- Defined in src/crypto/encrypt.ts:268

dataStream

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

Async
- Defined in src/crypto/encrypt.ts:316

metadata

metadata(param0): Promise<string>
Encrypt a string using the user's last master key.
Parameters
- param0: {
      derive?: boolean;
      key?: string;
      metadata: string;
  }
  - Optional derive?: boolean
  - Optional key?: string
  - metadata: string
Returns Promise<string>
Date
1/31/2024 - 3:59:29 PM

Async
- Defined in src/crypto/encrypt.ts:47

metadataPublic

metadataPublic(param0): Promise<string>
Encrypts metadata using a public key.
Parameters
- param0: {
  metadata: string;
  publicKey: string;
  }
  - metadata: string
  - publicKey: string
Returns Promise<string>
Date
2/2/2024 - 6:49:12 PM

Async
- Defined in src/crypto/encrypt.ts:112

noteContent

noteContent(param0): Promise<string>
Encrypt note content using the note's encryption key.
Parameters
- param0: {
  content: string;
  key: string;
  }
  - content: string
  - key: string
Returns Promise<string>
Date
2/6/2024 - 3:02:23 AM

Async
- Defined in src/crypto/encrypt.ts:171

notePreview

notePreview(param0): Promise<string>
Encrypt the note's preview using the note's encryption key.
Parameters
- param0: {
  key: string;
  preview: string;
  }
  - key: string
  - preview: string
Returns Promise<string>
Date
2/6/2024 - 3:02:56 AM

Async
- Defined in src/crypto/encrypt.ts:209

noteTagName

noteTagName(param0): Promise<string>
Encrypt a tag's name using the given key.
Parameters
- param0: {
  key?: string;
  name: string;
  }
  - Optional key?: string
  - name: string
Returns Promise<string>
Date
2/20/2024 - 3:21:12 AM

Async
- Defined in src/crypto/encrypt.ts:228

noteTitle

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

Async
- Defined in src/crypto/encrypt.ts:190

Generated using TypeDoc