API Docs for:
Show:

NCMB.Script Class

Defined in: lib/script.js:6

Scriptの実行を扱うクラスです。

メソッドは全て実行可能なインスタンスを生成し、状態を付与して返すファクトリメソッドです。 メソッドチェインでヘッダ、ボディ、クエリを付与し、execメソッドで実行します。

Script機能からのresponseは型が固定でないため、bodyキーにレスポンスを格納したObjectを返却します。

Item Index

Methods

Methods

data

(
  • body
)
Script

Defined in lib/script.js:55

インスタンスに対してチェインしてリクエストボディを付与するメソッドです。

Parameters:

  • body Object

    リクエストボディを示すJSON形式のオブジェクト

Returns:

Script:

this 引数のリクエストボディが付加された実行可能インスタンス

exec

(
  • method
  • scriptName
)
Object

Defined in lib/script.js:91

Scriptを実行するメソッドです。

Parameters:

  • method String

    HTTPメソッド

  • scriptName String

    スクリプトファイル名

Returns:

Object:

res Scriptに定義されたレスポンスを内包するJSON形式のオブジェクト

query

(
  • query
)
Script

Defined in lib/script.js:73

インスタンスに対してチェインしてクエリストリングを付与するメソッドです。

Parameters:

  • query Object

    クエリストリングを示すJSON形式のオブジェクト

Returns:

Script:

this 引数のクエリストリングが付加された実行可能インスタンス

set

(
  • header
)
Script

Defined in lib/script.js:34

インスタンスに対してチェインしてリクエストヘッダを付与するメソッドです。

Parameters:

  • header Object

    リクエストヘッダを示すJSON形式のオブジェクト

Returns:

Script:

this 引数のリクエストヘッダが付加された実行可能インスタンス