Class WechatKit

微信工具箱 auto=true 自动调用initConfig，这时候无法等待该方法的回调，所以如果是立即调用wxKit.sdk的场景最好手动调用initConfig后再获取wxKit.sdk

Constructors

constructor

new WechatKit(
    params: {
        appId?: string;
        auto?: boolean;
        fetchRequestOptions?: {
            baseUrl?: string;
            headers?: HeadersInit;
            init?: RequestInit;
            interceptors?: Interceptors;
            timeout?: number;
            useDataWrapper?: boolean;
        };
        jsApiList?: string[];
    },
): WechatKit
Parameters
- params: {
      appId?: string;
      auto?: boolean;
      fetchRequestOptions?: {
          baseUrl?: string;
          headers?: HeadersInit;
          init?: RequestInit;
          interceptors?: Interceptors;
          timeout?: number;
          useDataWrapper?: boolean;
      };
      jsApiList?: string[];
  }
Returns WechatKit
- Defined in kit/wechat.ts:99

Properties

`Readonly`_config

_config: Partial<Config>

baseUrl

baseUrl: string = ...

login: UseMemoizeReturn<
    Promise<string | void>,
    [
        params: {
            force?: boolean;
            scope?: WxLoginScope;
            withQrCodeLogin?: WithWxQrCodeLogin;
        },
    ],
> = ...

授权/扫码登录

Param: params

Memberof

WechatKit

`Optional`onUidChange

onUidChange?: (uid: string) => void

`Optional`openid

openid?: string

`Optional`proxyFor

proxyFor?: Account

`Optional`proxyRequest

proxyRequest?: (...params: [input: ProxyInput, options?: RequestInit]) => any

request

request: FetchRequest

`Optional`sdk

sdk?: typeof wx

微信sdk

`Optional`sdkCompleted

sdkCompleted?: Promise<undefined | typeof wx>

`Optional`uid

uid?: string = ...

userInfo

userInfo: UseMemoizeReturn<
Promise<WechatUserInfo & { headimgurl: undefined | string }>,
[],
> = ...

粉丝信息

Memberof

WechatKit

Methods

config

config(option?: Partial<Config>): Partial<Config>
获取配置
Parameters
- Optionaloption: Partial<Config>
Returns Partial<Config>
Memberof
WechatKit
- Defined in kit/wechat.ts:197

initConfig

initConfig(
config?: Partial<Pick<WxConfig, "debug" | "openTagList" | "jsApiList">>,
{?: { hideAllMenu?: boolean },
): Promise<void>
初始化wx.config
Parameters
- Optionalconfig: Partial<Pick<WxConfig, "debug" | "openTagList" | "jsApiList">>
- Optional{: { hideAllMenu?: boolean } = {}
Returns Promise<void>
Memberof
WechatKit
- Defined in kit/wechat.ts:136

logout

logout(): Promise<void>
登出

Returns Promise<void>
Memberof
WechatKit
- Defined in kit/wechat.ts:409

proxy

proxy(input: ProxyInput, options?: RequestInit): Promise<any>
代理接口
Parameters
- input: ProxyInput
- Optionaloptions: RequestInit
Returns Promise<any>
Memberof
WechatKit
- Defined in kit/wechat.ts:302

refreshLoginQrcode

refreshLoginQrcode(): undefined | { clear: () => void }
等待扫码登录成功

Returns undefined | { clear: () => void }
Memberof
WechatKit
- Defined in kit/wechat.ts:382

RequestAction

RequestAction(
type: string,
detail: Record<string, undefined | null | string | number | boolean>,
): Promise<{ code: number }>
行为事件上报
Parameters
- type: string
- detail: Record<string, undefined | null | string | number | boolean>
Returns Promise<{ code: number }>
Memberof
WechatKit
- Defined in kit/wechat.ts:273

RequestJsConfig

RequestJsConfig(
    url: string,
): Promise<
    {
        appid: string;
        code: number;
        nonceStr: string;
        signature: string;
        timestamp: string;
    },
>
请求微信授权参数
Parameters
- url: string
Returns Promise<
    {
        appid: string;
        code: number;
        nonceStr: string;
        signature: string;
        timestamp: string;
    },
>
Memberof
WechatKit
- Defined in kit/wechat.ts:287

RequestLogin

RequestLogin(
    params: {
        force?: boolean;
        scope?: WxLoginScope;
        withQrCodeLogin?: WithWxQrCodeLogin;
    },
): Promise<
    {
        base_redirect?: string;
        code: 200;
        openid?: string;
        qrcode?: string;
        redirect?: string;
        session?: string;
        uid?: string;
        user_redirect?: string;
    },
>
登录接口
Parameters
- params: { force?: boolean; scope?: WxLoginScope; withQrCodeLogin?: WithWxQrCodeLogin }
Returns Promise<
    {
        base_redirect?: string;
        code: 200;
        openid?: string;
        qrcode?: string;
        redirect?: string;
        session?: string;
        uid?: string;
        user_redirect?: string;
    },
>
Memberof
WechatKit
- Defined in kit/wechat.ts:219

RequestLoginout

RequestLoginout(): Promise<{ code: number }>
登出接口

Returns Promise<{ code: number }>
Memberof
WechatKit
- Defined in kit/wechat.ts:246

RequestLoginWait

RequestLoginWait(): Promise<{ code: number }>
等待扫码登录成功

Returns Promise<{ code: number }>
Memberof
WechatKit
- Defined in kit/wechat.ts:208

RequestProxy

RequestProxy(
input: ProxyInput,
options?: RequestInit,
): Promise<{ result: { error?: string } }>
请求代理的接口
Parameters
- input: ProxyInput
- Optionaloptions: RequestInit
Returns Promise<{ result: { error?: string } }>
Memberof
WechatKit
- Defined in kit/wechat.ts:263

RequestUserInfo

RequestUserInfo(): Promise<{ code: number; info: WechatUserInfo }>
获取用户信息接口

Returns Promise<{ code: number; info: WechatUserInfo }>
Memberof
WechatKit
- Defined in kit/wechat.ts:254

shareApp

shareApp(shareInfo?: ShareToUserConfig): Promise<void>
配置分享接口
Parameters
- OptionalshareInfo: ShareToUserConfig
Returns Promise<void>
Memberof
WechatKit
- Defined in kit/wechat.ts:164

Class WechatKit

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns WechatKit

Properties

Readonly_config

baseUrl

login

Param: params

Memberof

OptionalonUidChange

Optionalopenid

OptionalproxyFor

OptionalproxyRequest

request

Optionalsdk

OptionalsdkCompleted

Optionaluid

userInfo

Memberof

Methods

config

Parameters

Returns Partial<Config>

Memberof

initConfig

Parameters

Returns Promise<void>

Memberof

logout

Returns Promise<void>

Memberof

proxy

Parameters

Returns Promise<any>

Memberof

refreshLoginQrcode

Returns undefined | { clear: () => void }

Memberof

RequestAction

Parameters

Returns Promise<{ code: number }>

Memberof

RequestJsConfig

Parameters

Returns Promise< { appid: string; code: number; nonceStr: string; signature: string; timestamp: string; },>

Memberof

RequestLogin

Parameters

Returns Promise< { base_redirect?: string; code: 200; openid?: string; qrcode?: string; redirect?: string; session?: string; uid?: string; user_redirect?: string; },>

Memberof

RequestLoginout

Returns Promise<{ code: number }>

Memberof

RequestLoginWait

Returns Promise<{ code: number }>

Memberof

RequestProxy

Parameters

Returns Promise<{ result: { error?: string } }>

Memberof

RequestUserInfo

Returns Promise<{ code: number; info: WechatUserInfo }>

Memberof

shareApp

Parameters

Returns Promise<void>

Memberof

Settings

On This Page

`Readonly`_config

`Optional`onUidChange

`Optional`openid

`Optional`proxyFor

`Optional`proxyRequest

`Optional`sdk

`Optional`sdkCompleted

`Optional`uid

Returns Promise<
{
appid: string;
code: number;
nonceStr: string;
signature: string;
timestamp: string;
},
>

Returns Promise<
{
base_redirect?: string;
code: 200;
openid?: string;
qrcode?: string;
redirect?: string;
session?: string;
uid?: string;
user_redirect?: string;
},
>