weapp next

weapp-next

Weapp(微信小程序) 公式 API ラッパーは、ファッショナブルでフレンドリーで流暢なプログラミング API を公開することを目的としています。

特徴

• 約束された非同期 API

• wx.request API のショートカット

• 公式 API の強化

• RESTful httpクライアント

インストール

 # via Github
npm i xixilive/weapp-next --save-dev

 # via npm
npm i weapp-next --save-dev

例

非コールバックおよび RESTful HTTP

 const weapp = require ( 'weapp-next' ) ( wx )
const client = weapp . Http ( 'https://api.server.com/' )

//async/await
async function postLogin ( ) {
  const { code } = await weapp . login ( )
  const { errMsg , ... userInfo } = await weapp . getUserInfo ( { withCredentials : true } )
  return await client . post ( '/login' , { data : { ... userInfo , code } } )
}

//promise
function postLogin ( ) {
  const getUserInfo = code => opts => {
    return weapp . getUserInfo ( opts ) . then ( ( { errMsg , ... userInfo } ) => ( { userInfo , code } )
  }

  const postRequest = data => client . post ( '/login' , { data } )
  return weapp . login ( ) . then ( getUserInfo ) . then ( postRequest )
} 

使用法

weapp-next UMD モジュール システムを使用し、Commonjs または AMD 形式でロードできます。

 import weapp from 'weapp-next'

// get wrapped wx Object
const { request , Http } = weapp ( wx )

// use request API
request ( { url : 'https://test.com' , method : 'GET' } ) . then ( response => console . log )

// use shortcuts of request API, such as get, post, put, etc.
request . get ( 'https://test.com' ) . then ( response => console . log )

// use Http client
const http = Http ( 'https://server.com/api' )
http . get ( '/path' ) . then ( response => console . log )

// or
const weapp = require ( 'weapp-next' ) ( wx )

ほぼすべての公式 API をラップします。「ラップされたメソッド」を参照してください。

機能強化

wechat ミニプログラムで宣言された動詞 (RFC 2616) に従って、http リクエストのショートカットを作成します。特に、 PATCH動詞は厳密な RESTful-ist に役立つ可能性があるため、定義もされています。

weapp.request

[200, 300) の範囲内の statusCode を取る応答を解決し、範囲外の応答を拒否します。

解決された応答と拒否された理由/エラーは、ネイティブwx.requestからの応答オブジェクトです。

 import weapp from 'weapp-next'
const { request } = weapp ( wx )

request ( { url , method : 'GET' } )
  . then ( response => {
    // response is the response object from wx.request
  } )
  . catch ( error => {
    // error is the response object from wx.request
  } )

request . get ( url : String [ , init : Function ] )
request . post ( url : String , body : String / Object , [ , init : Function ] )
request . put ( url : String , body : String / Object , [ , init : Function ] )
request . patch ( url : String , body : String / Object , [ , init : Function ] )
request . delete ( url : String [ , init : Function ] )
request . head ( url : String [ , init : Function ] )
request . options ( url : String [ , init : Function ] )
request . trace ( url : String [ , init : Function ] )
request . connect ( url : String [ , init : Function ] )

オプションのinit引数は、リクエスト パラメータを補間するための引数ゼロの関数であり、規約によりオブジェクト値を返すことが期待されます。 urlとmethodを除く、返されたオブジェクトによってリクエスト パラメータをオーバーライドできます。

 // logic of init function
const config = { ... }
return { ... config , ... init ( ) , url , method }

weapp.requireAuth (DPRECIATED)

低価格

これは、Weapp ログインと getUserInfo ロジックを簡単に統合できるようにすることを目的とした、Weapp ログイン シナリオ用の Express ミドルウェアです。エクスプレス-Weapp-認証

RESTful HTTP クライアントを使用する

 import weapp from 'weapp-next'

const http = weapp ( wx ) . Http ( 'https://api.server.com/' )
http . get ( '/status' , { version : '1' } ) // /status?version=1
http . post ( '/status' , { data : { } } ) 

変更点

変更ログ