Skip to content

Commit a3bfdc1

Browse files
committed
fix: types
1 parent f9c70d3 commit a3bfdc1

2 files changed

Lines changed: 5 additions & 6 deletions

File tree

index.d.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ export function createSymmetricKeyFromText(key: string, extractable?: boolean, t
2020
* @param {string} text - String value to be encrypted.
2121
* @param {boolean} [urlSafe] - The encrypted values default to `base64` alphabet; this property enables the `base64url` alphabet. Enabled by default.
2222
* @param {TextEncoder} [textEncoder] - If you have an instance of a `TextEncoder`, you can reuse it.
23-
* @param {BufferSource} [additionalData] - Additional data to be included in the encryption process (authentication tag).
23+
* @param {BufferSource} [additionalData] - Additional data for authentication.
2424
* @returns {Promise<string>} The value encrypted and encoded as a Base64 string.
2525
* @throws {DOMException} Raised when:
2626
* - The provided key is not valid.
@@ -35,7 +35,7 @@ export function encryptTextSymmetrically(key: CryptoKey, text: string, urlSafe?:
3535
* @param {CryptoKey} key - Symmetric key used to encrypt the value.
3636
* @param {string} ciphertext - Encrypted value to be decrypted.
3737
* @param {TextDecoder} [textDecoder] - If you have an instance of a `TextDecoder`, you can reuse it.
38-
* @param {BufferSource} [additionalData] - Additional data to be included in the encryption process (authentication tag).
38+
* @param {BufferSource} [additionalData] - Additional data for authentication.
3939
* @returns {Promise<string>} The value decrypted.
4040
* @throws {TypeError} Thrown if `ciphertext` is not a string.
4141
* @throws {SyntaxError} Thrown if `ciphertext` contains characters outside Base64 alphabet.
@@ -68,7 +68,7 @@ export class SingleCryptText {
6868
* @async
6969
* @param {string} text - String value to be encrypted.
7070
* @param {boolean} [urlSafe] - The encrypted values default to `base64` alphabet; this property enables the `base64url` alphabet. Enabled by default.
71-
* @param {BufferSource} [additionalData] - Additional data to be included in the encryption process (authentication tag).
71+
* @param {BufferSource} [additionalData] - Additional data for authentication.
7272
* @returns {Promise<string>} The value encrypted and encoded as a Base64 string.
7373
* @throws {DOMException} Raised when:
7474
* - The provided key is not valid.
@@ -78,7 +78,7 @@ export class SingleCryptText {
7878
/**
7979
* @async
8080
* @param {string} ciphertext - Encrypted value to be decrypted.
81-
* @param {BufferSource} [additionalData] - Additional data to be included in the encryption process (authentication tag).
81+
* @param {BufferSource} [additionalData] - Additional data for authentication.
8282
* @returns {Promise<string>} The value decrypted.
8383
* @throws {TypeError} Thrown if `ciphertext` is not a string.
8484
* @throws {SyntaxError} Thrown if `ciphertext` contains characters outside Base64 alphabet.

package.json

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,8 +47,7 @@
4747
"test:random": "bun test --randomize",
4848
"build": "bun build ./index.js --minify --target browser --outdir ./dist --entry-naming [dir]/[name].min.[ext]",
4949
"build:cjs": "bun build ./index.js --minify --format cjs --outdir ./dist --entry-naming [dir]/[name].node.min.[ext]",
50-
"build:types": "tsc",
51-
"docs": "typedoc"
50+
"build:types": "tsc"
5251
},
5352
"type": "module",
5453
"types": "index.d.ts",

0 commit comments

Comments
 (0)