Skip to content

优化代码,以及文档 #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: develop
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ git clone https://github.com/ai-lowcode/core
pnpm install

# 启动开发服务器
pnpm --filter "ai-lowcode-admin" "dev"
pnpm dev
```

### 加入社区
Expand Down
34 changes: 17 additions & 17 deletions packages/hooks/markdown/hooks.localforage.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [@ai-lowcode/hooks](./hooks.md) &gt; [localForage](./hooks.localforage.md)
## localForage() function
二次封装 \[localforage\](https://localforage.docschina.org/) 支持设置过期时间,提供完整的类型提示
**Signature:**
```typescript
localForage: () => StorageProxy
```
**Returns:**
StorageProxy
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@ai-lowcode/hooks](./hooks.md) &gt; [localForage](./hooks.localforage.md)

## localForage() function

二次封装 \[localforage\](https://localforage.docschina.org/) 支持设置过期时间,提供完整的类型提示

**Signature:**

```typescript
localForage: () => StorageProxy
```
**Returns:**

StorageProxy

128 changes: 64 additions & 64 deletions packages/hooks/markdown/hooks.md
Original file line number Diff line number Diff line change
@@ -1,64 +1,64 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [@ai-lowcode/hooks](./hooks.md)
## hooks package
## Functions
<table><thead><tr><th>
Function
</th><th>
Description
</th></tr></thead>
<tbody><tr><td>
[localForage()](./hooks.localforage.md)
</td><td>
二次封装 \[localforage\](https://localforage.docschina.org/) 支持设置过期时间,提供完整的类型提示
</td></tr>
<tr><td>
[useEventBus(eventNames)](./hooks.useeventbus.md)
</td><td>
</td></tr>
</tbody></table>
## Variables
<table><thead><tr><th>
Variable
</th><th>
Description
</th></tr></thead>
<tbody><tr><td>
[webStorage](./hooks.webstorage.md)
</td><td>
</td></tr>
</tbody></table>
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@ai-lowcode/hooks](./hooks.md)

## hooks package

## Functions

<table><thead><tr><th>

Function


</th><th>

Description


</th></tr></thead>
<tbody><tr><td>

[localForage()](./hooks.localforage.md)


</td><td>

二次封装 \[localforage\](https://localforage.docschina.org/) 支持设置过期时间,提供完整的类型提示


</td></tr>
<tr><td>

[useEventBus(eventNames)](./hooks.useeventbus.md)


</td><td>


</td></tr>
</tbody></table>

## Variables

<table><thead><tr><th>

Variable


</th><th>

Description


</th></tr></thead>
<tbody><tr><td>

[webStorage](./hooks.webstorage.md)


</td><td>


</td></tr>
</tbody></table>
102 changes: 51 additions & 51 deletions packages/hooks/markdown/hooks.useeventbus.md
Original file line number Diff line number Diff line change
@@ -1,51 +1,51 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [@ai-lowcode/hooks](./hooks.md) &gt; [useEventBus](./hooks.useeventbus.md)
## useEventBus() function
**Signature:**
```typescript
export declare function useEventBus(eventNames?: string[]): any;
```
## Parameters
<table><thead><tr><th>
Parameter
</th><th>
Type
</th><th>
Description
</th></tr></thead>
<tbody><tr><td>
eventNames
</td><td>
string\[\]
</td><td>
_(Optional)_
</td></tr>
</tbody></table>
**Returns:**
any
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@ai-lowcode/hooks](./hooks.md) &gt; [useEventBus](./hooks.useeventbus.md)

## useEventBus() function

**Signature:**

```typescript
export declare function useEventBus(eventNames?: string[]): any;
```

## Parameters

<table><thead><tr><th>

Parameter


</th><th>

Type


</th><th>

Description


</th></tr></thead>
<tbody><tr><td>

eventNames


</td><td>

string\[\]


</td><td>

_(Optional)_


</td></tr>
</tbody></table>
**Returns:**

any

22 changes: 11 additions & 11 deletions packages/hooks/markdown/hooks.webstorage.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [@ai-lowcode/hooks](./hooks.md) &gt; [webStorage](./hooks.webstorage.md)
## webStorage variable
**Signature:**
```typescript
webStorage: WebStorage
```
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@ai-lowcode/hooks](./hooks.md) &gt; [webStorage](./hooks.webstorage.md)

## webStorage variable

**Signature:**

```typescript
webStorage: WebStorage
```
58 changes: 29 additions & 29 deletions packages/hooks/markdown/index.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,29 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md)
## API Reference
## Packages
<table><thead><tr><th>
Package
</th><th>
Description
</th></tr></thead>
<tbody><tr><td>
[@ai-lowcode/hooks](./hooks.md)
</td><td>
</td></tr>
</tbody></table>
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md)

## API Reference

## Packages

<table><thead><tr><th>

Package


</th><th>

Description


</th></tr></thead>
<tbody><tr><td>

[@ai-lowcode/hooks](./hooks.md)


</td><td>


</td></tr>
</tbody></table>
2 changes: 1 addition & 1 deletion scripts/rollup-dts.js
Original file line number Diff line number Diff line change
Expand Up @@ -54,4 +54,4 @@ async function run() {
}
}

run()
await run()