类 WechatKit

constructor

• new WechatKit(params): WechatKit

• 参数

  • params: {
        appId?: string;
        auto?: boolean;
        fetchRequestOptions?: {
            baseUrl?: string;
            headers?: HeadersInit;
            init?: RequestInit;
            interceptors?: Interceptors;
            timeout?: number;
            useDataWrapper?: boolean;
        };
        jsApiList?: string[];
    }

    • 可选appId?: string

    • 可选auto?: boolean

    • 可选fetchRequestOptions?: {
          baseUrl?: string;
          headers?: HeadersInit;
          init?: RequestInit;
          interceptors?: Interceptors;
          timeout?: number;
          useDataWrapper?: boolean;
      }

      • 可选baseUrl?: string

      • 可选headers?: HeadersInit

      • 可选init?: RequestInit

      • 可选interceptors?: Interceptors

      • 可选timeout?: number

      • 可选useDataWrapper?: boolean

    • 可选jsApiList?: string[]

  返回 WechatKit

只读_config

baseUrl

login

可选onUidChange

可选openid

可选proxyFor

可选proxyRequest

request

可选sdk

可选sdkCompleted

可选uid

userInfo

config

• config(option?): Partial<Config>

• 获取配置

  参数

  • 可选option: Partial<Config>

  返回 Partial<Config>

  Memberof

  WechatKit

initConfig

• initConfig(config?, {?): Promise<void>

• 初始化wx.config

  参数

  • 可选config: Partial<Pick<WxConfig, "debug" | "openTagList" | "jsApiList">>
  • 可选{: {
        hideAllMenu?: boolean;
    }

    • 可选hideAllMenu?: boolean

  返回 Promise<void>

  Memberof

  WechatKit

logout

• logout(): Promise<void>

• 登出

  返回 Promise<void>

  Memberof

  WechatKit

proxy

• proxy(input, options?): Promise<any>

• 代理接口

  参数

  • input: ProxyInput
  • 可选options: RequestInit

  返回 Promise<any>

  Memberof

  WechatKit

refreshLoginQrcode

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

• 等待扫码登录成功

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

  Memberof

  WechatKit

RequestAction

• RequestAction(type, detail): Promise<{
      code: number;
  }>

• 行为事件上报

  参数

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

  返回 Promise<{
      code: number;
  }>

  Memberof

  WechatKit

RequestJsConfig

• RequestJsConfig(url): Promise<{
      appid: string;
      code: number;
      nonceStr: string;
      signature: string;
      timestamp: string;
  }>

• 请求微信授权参数

  参数

  • url: string

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

  Memberof

  WechatKit

RequestLogin

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

• 登录接口

  参数

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

    • 可选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;
  }>

  Memberof

  WechatKit

RequestLoginout

• RequestLoginout(): Promise<{
      code: number;
  }>

• 登出接口

  返回 Promise<{
      code: number;
  }>

  Memberof

  WechatKit

RequestLoginWait

• RequestLoginWait(): Promise<{
      code: number;
  }>

• 等待扫码登录成功

  返回 Promise<{
      code: number;
  }>

  Memberof

  WechatKit

RequestProxy

• RequestProxy(input, options?): Promise<{
      result: {
          error?: string;
      };
  }>

• 请求代理的接口

  参数

  • input: ProxyInput
  • 可选options: RequestInit

  返回 Promise<{
      result: {
          error?: string;
      };
  }>

  Memberof

  WechatKit

RequestUserInfo

• RequestUserInfo(): Promise<{
      code: number;
      info: WechatUserInfo;
  }>

• 获取用户信息接口

  返回 Promise<{
      code: number;
      info: WechatUserInfo;
  }>

  Memberof

  WechatKit

shareApp

• shareApp(shareInfo?): Promise<void>

• 配置分享接口

  参数

  • 可选shareInfo: ShareToUserConfig

  返回 Promise<void>

  Memberof

  WechatKit