# @justwei/capacitor-wechat

j

## Install

```bash
npm install @justwei/capacitor-wechat
npx cap sync
```

## API

<docgen-index>

* [`echo(...)`](#echo)
* [`registerWx()`](#registerwx)
* [`authLogin()`](#authlogin)
* [`pay(...)`](#pay)
* [`share(...)`](#share)
* [Type Aliases](#type-aliases)

</docgen-index>

<docgen-api>
<!--Update the source file JSDoc comments and rerun docgen to update the docs below-->

### echo(...)

```typescript
echo(options: { value: string; }) => Promise<{ value: string; }>
```

| Param         | Type                            |
| ------------- | ------------------------------- |
| **`options`** | <code>{ value: string; }</code> |

**Returns:** <code>Promise&lt;{ value: string; }&gt;</code>

--------------------


### registerWx()

```typescript
registerWx() => void
```

--------------------


### authLogin()

```typescript
authLogin() => Promise<any>
```

**Returns:** <code>Promise&lt;any&gt;</code>

--------------------


### pay(...)

```typescript
pay(payParams: PayParams) => Promise<{ payResult: string; }>
```

| Param           | Type                                            |
| --------------- | ----------------------------------------------- |
| **`payParams`** | <code><a href="#payparams">PayParams</a></code> |

**Returns:** <code>Promise&lt;{ payResult: string; }&gt;</code>

--------------------


### share(...)

```typescript
share(shareParams: ShareParams) => Promise<{ result: 'success' | 'cancel' | 'denied' | 'fail'; }>
```

| Param             | Type                                                |
| ----------------- | --------------------------------------------------- |
| **`shareParams`** | <code><a href="#shareparams">ShareParams</a></code> |

**Returns:** <code>Promise&lt;{ result: 'success' | 'cancel' | 'denied' | 'fail'; }&gt;</code>

--------------------


### Type Aliases


#### PayParams

<code>{ appid: string; noncestr: string; package: string; partnerid: string; prepayid: string; sign: string; timestamp: string; }</code>


#### ShareParams

微信分享参数

<code>{ /** * 分享类型 * * text: 文本 * * image: 图片 * * link: 链接 * * miniProgram: 小程序 */ type: <a href="#sharetype">ShareType</a>; /** * 分享标题（链接/小程序需要） * * 限制长度不超过 512Bytes */ title?: string; /** * 分享描述（文本/链接需要） * * 限制长度不超过 1KB */ description?: string; /** * 链接分享的目标URL（链接类型需要） */ url?: string; /** * 缩略图路径（本地文件路径或网络URL） * * 图片不超过 32KB */ thumbPath?: string; /** * 图片路径（本地文件路径或网络URL，图片类型需要） */ imagePath?: string; /** * 小程序原始ID（小程序类型需要） */ miniProgramId?: string; /** * 小程序页面路径（小程序类型需要） */ miniProgramPath?: string; /** * 分享场景（会话/朋友圈/收藏） * * * 会话：session * * 朋友圈：timeline * * 收藏：favorite */ scene: 'session' | 'timeline' | 'favorite'; }</code>


#### ShareType

分享类型
* text: 文本
* image: 图片
* link: 链接
* miniProgram: 小程序

<code>'text' | 'image' | 'link' | 'miniProgram'</code>

</docgen-api>