Class WechatKit

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

Hierarchy

WechatKit

Index

Constructors

constructor

new WechatKit(params): WechatKit
Parameters
- params: {
      appId?: string;
      auto?: boolean;
      jsApiList?: string[];
  }
  - Optional appId?: string
  - Optional auto?: boolean
  - Optional jsApiList?: string[]
Returns WechatKit
- Defined in kit/wechat.ts:88

Properties

`Private` LEGACY_UID_KEY

LEGACY_UID_KEY: string = '_uid'

`Private` UID_KEY

UID_KEY: string = '_wx_uid'

`Readonly` _config

_config: Partial<Config>

baseUrl

baseUrl: string = ...

login

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

授权/扫码登录

Param

Memberof

WechatKit

`Optional` openid

openid?: string

`Optional` proxyFor

proxyFor?: Account

`Optional` proxyRequest

proxyRequest?: ((...params) => any)

Type declaration

- (...params): any
- Parameters
  - Rest ...params: [input: ProxyInput, options?: RequestInit]
  Returns 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

RequestAction

RequestAction(type, detail): Promise<{
code: number;
}>
行为事件上报

Memberof
WechatKit
Parameters
- type: string
- detail: Record<string, undefined | null | string | number | boolean>
Returns Promise<{
code: number;
}>
- Defined in kit/wechat.ts:249

RequestJsConfig

RequestJsConfig(url): Promise<{
    appid: string;
    code: number;
    nonceStr: string;
    signature: string;
    timestamp: string;
}>
请求微信授权参数

Memberof
WechatKit
Parameters
- url: string
Returns Promise<{
    appid: string;
    code: number;
    nonceStr: string;
    signature: string;
    timestamp: string;
}>
- Defined in kit/wechat.ts:260

RequestLogin

RequestLogin(params): Promise<{
    base_redirect?: string;
    code: 200;
    openid?: string;
    qrcode?: string;
    redirect?: string;
    session?: string;
    uid?: string;
    user_redirect?: string;
}>
登录接口

Memberof
WechatKit
Parameters
- params: {
      force?: boolean;
      scope?: WxLoginScope;
      withQrCodeLogin?: WithWxQrCodeLogin;
  }
  - Optional force?: boolean
  - Optional scope?: WxLoginScope
  - Optional withQrCodeLogin?: WithWxQrCodeLogin
Returns Promise<{
    base_redirect?: string;
    code: 200;
    openid?: string;
    qrcode?: string;
    redirect?: string;
    session?: string;
    uid?: string;
    user_redirect?: string;
}>
- Defined in kit/wechat.ts:199

RequestLoginWait

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

Memberof
WechatKit

Returns Promise<{
code: number;
}>
- Defined in kit/wechat.ts:189

RequestLoginout

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

Memberof
WechatKit

Returns Promise<{
code: number;
}>
- Defined in kit/wechat.ts:225

RequestProxy

RequestProxy(input, options?): Promise<{
    result: {
        error?: string;
    };
}>
请求代理的接口

Memberof
WechatKit
Parameters
- input: ProxyInput
- Optional options: RequestInit
Returns Promise<{
    result: {
        error?: string;
    };
}>
- Defined in kit/wechat.ts:240

RequestUserInfo

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

Memberof
WechatKit

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

config

config(option?): Partial<Config>
获取配置

Memberof
WechatKit
Parameters
- Optional option: Partial<Config>
Returns Partial<Config>
- Defined in kit/wechat.ts:178

initConfig

initConfig(config?, [{?): Promise<void>
初始化wx.config

Memberof
WechatKit
Parameters
- Optional config: Partial<Pick<WxConfig, "debug" | "openTagList" | "jsApiList">>
- Optional [{: {
  hideAllMenu: undefined | boolean;
  } = {}
  
  debug = false }={}]
  - hideAllMenu: undefined | boolean
Returns Promise<void>
- Defined in kit/wechat.ts:119

logout

logout(): Promise<void>
登出

Memberof
WechatKit

Returns Promise<void>
- Defined in kit/wechat.ts:369

proxy

proxy(input, options?): Promise<any>
代理接口

Memberof
WechatKit
Parameters
- input: ProxyInput
- Optional options: RequestInit
Returns Promise<any>
- Defined in kit/wechat.ts:274

refreshLoginQrcode

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

Memberof
WechatKit

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

shareApp

shareApp(shareInfo?): Promise<void>
配置分享接口

Memberof
WechatKit
Parameters
- Optional shareInfo: ShareToUserConfig
Returns Promise<void>
- Defined in kit/wechat.ts:146

Class WechatKit

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

params: { appId?: string; auto?: boolean; jsApiList?: string[]; }

Optional appId?: string

Optional auto?: boolean

Optional jsApiList?: string[]

Returns WechatKit

Properties

Private LEGACY_UID_KEY

Private UID_KEY

Readonly _config

baseUrl

login

Param

Memberof

Optional openid

Optional proxyFor

Optional proxyRequest

Type declaration

Parameters

Rest ...params: [input: ProxyInput, options?: RequestInit]

Returns any

request

Optional sdk

Optional sdkCompleted

Optional uid

userInfo

Memberof

Methods

RequestAction

Memberof

Parameters

type: string

detail: Record<string, undefined | null | string | number | boolean>

Returns Promise<{ code: number; }>

RequestJsConfig

Memberof

Parameters

url: string

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

RequestLogin

Memberof

Parameters

params: { force?: boolean; scope?: WxLoginScope; withQrCodeLogin?: WithWxQrCodeLogin; }

Optional force?: boolean

Optional scope?: WxLoginScope

Optional withQrCodeLogin?: WithWxQrCodeLogin

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

RequestLoginWait

Memberof

Returns Promise<{ code: number; }>

RequestLoginout

Memberof

Returns Promise<{ code: number; }>

RequestProxy

Memberof

Parameters

input: ProxyInput

Optional options: RequestInit

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

RequestUserInfo

Memberof

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

config

Memberof

Parameters

Optional option: Partial<Config>

Returns Partial<Config>

initConfig

Memberof

Parameters

Optional config: Partial<Pick<WxConfig, "debug" | "openTagList" | "jsApiList">>

Optional [{: { hideAllMenu: undefined | boolean; } = {}

params: {
appId?: string;
auto?: boolean;
jsApiList?: string[];
}

`Optional` appId?: string

`Optional` auto?: boolean

`Optional` jsApiList?: string[]

`Private` LEGACY_UID_KEY

`Private` UID_KEY

`Readonly` _config

`Optional` openid

`Optional` proxyFor

`Optional` proxyRequest

`Rest` ...params: [input: ProxyInput, options?: RequestInit]

`Optional` sdk

`Optional` sdkCompleted

`Optional` uid

Returns Promise<{
code: number;
}>

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

params: {
force?: boolean;
scope?: WxLoginScope;
withQrCodeLogin?: WithWxQrCodeLogin;
}

`Optional` force?: boolean

`Optional` scope?: WxLoginScope

`Optional` withQrCodeLogin?: WithWxQrCodeLogin

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

Returns Promise<{
code: number;
}>

Returns Promise<{
code: number;
}>

`Optional` options: RequestInit

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

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

`Optional` option: Partial<Config>

`Optional` config: Partial<Pick<WxConfig, "debug" | "openTagList" | "jsApiList">>

`Optional` [{: {
hideAllMenu: undefined | boolean;
} = {}

`Optional` options: RequestInit

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

`Optional` shareInfo: ShareToUserConfig