Skip to content

Commit 1965d06

Browse files
authored
Merge pull request #459 from Peefy/docs-crypto-and-base64-module
docs: update crypto and base64 module docs
2 parents b785e7e + 15249e6 commit 1965d06

File tree

4 files changed

+16
-4
lines changed

4 files changed

+16
-4
lines changed

docs/reference/model/base64.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,6 @@ Encode the string `value` using the codec registered for encoding.
1414

1515
## decode
1616

17-
`decode(value: str, encoding: str = "utf-8") -> str`
17+
`decode(value: str) -> str`
1818

19-
Decode the string `value` using the codec registered for encoding.
19+
Decode the string `value` using the codec registered to the utf8 string for encoding.

docs/reference/model/crypto.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,12 @@ Encrypt the string `value` using `SHA384` and the codec registered for encoding.
4242

4343
Encrypt the string `value` using `SHA512` and the codec registered for encoding.
4444

45+
## blake3
46+
47+
`blake3(value: str, encoding: str = "utf-8") -> str`
48+
49+
Encrypt the string `value` using `BLAKE3` and the codec registered for encoding.
50+
4551
## uuid
4652

4753
`uuid() -> str`

i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/model/base64.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,6 @@ weight: 100
1414

1515
## decode
1616

17-
`decode(value: str, encoding: str = "utf-8") -> str`
17+
`decode(value: str) -> str`
1818

19-
使用注册的编码器对字符串 `value` 进行解码
19+
使用注册的编码器对字符串 `value` 进行解码,解码的结果是一个 utf8 字符串

i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/model/crypto.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,12 @@ weight: 100
4242

4343
使用注册编码器和 `SHA512` 算法对字符串 `value` 进行加密。
4444

45+
## blake3
46+
47+
`sha512(value: str, encoding: str = "utf-8") -> str`
48+
49+
使用注册编码器和 `BLAKE3` 算法对字符串 `value` 进行加密。
50+
4551
## uuid
4652

4753
`uuid() -> str`

0 commit comments

Comments
 (0)