📃 docs: useSnowflakeId

use-py · Aug 20, 2023 · a904ef4 · a904ef4
1 parent 13b253f
commit a904ef4
Show file tree

Hide file tree

Showing 2 changed files with 27 additions and 0 deletions.
diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts
@@ -140,6 +140,10 @@ export default withPwa(defineConfig({
               text: 'useParser',
               link: '/api/parser',
             },
+            {
+              text: 'useSnowflakeId',
+              link: '/api/useSnowflakeId',
+            },
           ],
         },
         {

diff --git a/docs/api/useSnowflakeId.md b/docs/api/useSnowflakeId.md
@@ -0,0 +1,23 @@
+---
+outline: deep
+---
+## useSnowflakeId
+
+用于生成分布式唯一ID。
+
+```python
+from usepy import useSnowflakeId
+
+snowflake = useSnowflakeId()
+snowflake.generate_id() # 生成唯一ID
+```
+
+### 参数
+
+- `datacenter_id`：数据中心ID，范围为0-31，可选，默认为1
+- `worker_id`：工作机器ID，范围为0-31，可选，默认为1
+- `sequence`：序列号，范围为0-4095，占12位，可选，默认为0
+
+### 返回值
+
+- `id`：唯一ID