スクリプトAPIリファレンス
Hodorは内蔵のJavaScriptエンジンでスクリプトを実行します。スクリプトタイプに応じて、Hodorは下のエントリ関数のいずれかを適切なタイミングで呼び出します — 必要なロジックだけを実装してください。何も変更しない場合は、未使用のエントリ関数を削除して不要な呼び出しを避けます。
利用可能なグローバルオブジェクトとクラス:
| カテゴリ | 名前 |
|---|---|
| エントリ関数 | onRequest, onResponse, onSessionCompleted, onSchedule, abort() |
ネイティブ $ モジュール | $codec, $hash, $hmac, $crypto, $jwt, $format, $fs, $env, $uuid, $log |
| Web標準API | fetch, HTTPClient, setTimeout / setInterval, btoa / atob / sleep / require / TextEncoder / crypto, console |
| HTTPクラス | Request, Response, Body, Headers, URLSearchParams |
| ストレージ | SharedPreferences, sdk 変数 |
| コンテキスト | RewriteContext, CompletedContext, ScheduleContext |
スクリプト内の任意の場所で console.log(...) を使って値を確認できます — 出力はスクリプトのログビューに表示されます。
エントリ関数
スクリプトは async function 宣言をスキャンして検出されます — 各エントリ関数の引数の数は固定です(onRequest/onResponse は3つ、onSessionCompleted は4つ、onSchedule は1つ)。アロー関数の代入(let onRequest = async (...) => {})は検出されません。引数名は自由です。
onRequest(context, url, request)
書き換えスクリプトとQuick Request送信前スクリプト向けです。HTTPリクエストがサーバーに送られる前に呼び出されます。(変更済みの可能性がある)request を返します。
| 引数 | 型 | 説明 |
|---|---|---|
context | RewriteContext | コンテキストオブジェクト。 |
url | string | HTTPリクエストのURL。 |
request | Request | HTTPリクエストオブジェクト。 |
// modify request body
async function onRequest(context, url, request) {
// parse to Text
var text = request.body.parseText()
console.log(text)
request.body = "this is a replaced request text"
// parse to JSON
var json = request.body.parseJSON()
json["script_json"] = "JSONValue"
request.body = json
// parse to URLSearchParams
var urlencoded = request.body.parseURLSearchParams()
urlencoded.append("script", "parseURLSearchParams")
request.body = urlencoded
// Done
return request;
}
// redirect, modify path / queries / headers
async function onRequest(context, url, request) {
console.log(url);
// set a parameter, you can get it in onResponse
context.parameters["custom"] = "custom parameter on request"
// redirect
request.scheme = "http"
request.path = "/upload/json"
request.host = "192.168.3.30"
request.port = 6000
// change method
request.method = "POST"
// queries operation
request.queries.append("name", "value1") // add query
request.queries.set("name", "value2") // replace or add query
request.queries.get("name") // get query by name
request.queries.delete("name") // delete query by name
// headers operation
request.headers.delete("accept") // delete header by name
request.headers.append("hodor", "custom value") // add name-value pair
request.headers.forEach((value, name) => {
console.log(name + ":" + value)
});
// Done
return request;
}
onResponse(context, url, response)
書き換えスクリプトとQuick Requestレスポンス後スクリプト向けです。HTTPレスポンスがクライアントに送られる前に呼び出されます。(変更済みの可能性がある)response を返します。
| 引数 | 型 | 説明 |
|---|---|---|
context | RewriteContext | コンテキストオブジェクト。 |
url | string | HTTPレスポンスのURL。 |
response | Response | HTTPレスポンスオブジェクト。 |
// response body
async function onResponse(context, url, response) {
// parse to Text
var text = response.body.parseText()
console.log(text)
response.body = "this is a replaced response text"
// parse to JSON
var json = response.body.parseJSON()
json["script_json"] = "JSONValue"
response.body = json
// parse to URLSearchParams
var urlencoded = response.body.parseURLSearchParams()
urlencoded.append("script", "parseURLSearchParams")
response.body = urlencoded
// Done
return response;
}
// change status code and headers
async function onResponse(context, url, response) {
// get parameters set in onRequest
console.log(context.parameters["custom"]) // Output "custom parameter on request"
response.statusCode = 200 // change status code
response.statusPhrase = "OK" // change status phrase
response.headers.delete("accept")
response.headers.append("hodor", "custom value")
response.headers.forEach((value, name) => {
console.log(name + ":" + value)
});
// Done
return response
}
onSessionCompleted(context, url, request, response)
HTTP completedスクリプト向けです。HTTPレスポンスが返った後に非同期で呼び出され、アプリとサーバー間のデータ伝送には影響しません。データ収集と転送に便利です。
| 引数 | 型 | 説明 |
|---|---|---|
context | CompletedContext | コンテキストオブジェクト。 |
url | string | HTTPリクエストのURL。 |
request | Request | HTTPリクエストオブジェクト。 |
response | Response | HTTPレスポンスオブジェクト。 |
// sample: pass session data to your own server
async function onSessionCompleted(context, url, request, response) {
try {
var reqText = request.body.parseText();
var rspText = response.body.parseText()
var params = {
"body": { // HTTPClient post body data
"url": url, // request url
"reqHeader": request.headers.encode(), // request headers
"reqText": reqText, // request body
"rspHeader": response.headers.encode(), // response headers
"rspText": rspText, // response body
},
"headers": { // HTTPClient headers
"from": "onSessionCompleted"
},
}
const rsp = await HTTPClient.post("http://192.168.3.30:8000/upload", params)
let text = rsp.body.parseText()
console.log(text)
} catch(error) {
console.log(error)
}
}
onSchedule(context)
スケジュールスクリプト向けです。予定されたトリガー時刻に呼び出されます(5または6フィールドのcron式に 対応)。スケジュールループを止めるには abort() を使います。
| 引数 | 型 | 説明 |
|---|---|---|
context | ScheduleContext | コンテキストオブジェクト。 |
async function onSchedule(context) {
// set custom parameters for next runloop
context.parameters["custom"] = "custom parameters for next runloop";
// repeated count
console.log(`repeatedCount ${context.repeatedCount}`);
// if repeatedCount is 2, abort schedule
if (context.repeatedCount == 2) {
abort()
}
// you can also use HTTPClient to send requests
const rsp = await HTTPClient.get("https://www.apple.com")
let text = rsp.body.parseText()
console.log(text)
}
abort()
チャネルスクリプト(onRequest / onResponse / onSchedule)の中で abort() を呼ぶと、スクリプトを停止し現在の実行を即座に中断します — AbortError が投げられ、Hodorがそれを報告します。
// ✅ correct — abort() is injected into the script scope
async function onRequest(context, url, request) {
if (url.includes("/tracking")) abort();
return request;
}
onRequest(context, url, request, aborter) のように4番目の引数を宣言しないでください。エントリ関数の引数の数は固定です — 4番目の引数があるとエントリが検出されなくなります。
ネイティブモジュール
$ 接頭辞のモジュールはすべて、ランタイムの起動時に注入されます。ネイティブ実装で、同期的に返り(特記のない限り)、文字列入力をUTF-8として扱います。
$codec — エンコードとデコード
プロトコル変換とデータ転送のためのBase64 / Hex / URLパーセントエンコーディング。
| メソッド | 返り値 |
|---|---|
$codec.base64Encode(str) | Base64文字列。 |
$codec.base64Decode(str) | デコードされた文字列。無効な入力は "" を返します(例外は投げない)。 |
$codec.hexEncode(str) | 小文字のhex文字列。 |
$codec.hexDecode(str) | デコードされた文字列。無効な文字はスキップされます。 |
$codec.urlEncode(str) | パーセントエンコードされた文字列。 |
$codec.urlDecode(str) | デコードされた文字列。無効なシーケンスはそのまま返されます。 |
$codec.base64Encode("Hello, World!"); // "SGVsbG8sIFdvcmxkIQ=="
$codec.base64Decode("SGVsbG8sIFdvcmxkIQ=="); // "Hello, World!"
$codec.hexEncode("ABC"); // "414243"
$codec.hexDecode("414243"); // "ABC"
$codec.urlEncode("hello world&foo=bar"); // "hello%20world%26foo%3Dbar"
$hash — ハッシュ
整合性チェック、コンテンツアドレス指定、匿名化のためのダイジェスト計算。小文字のhexを返します。
| メソッド | 出力長 |
|---|---|
$hash.md5(str) | 32文字のhex |
$hash.sha1(str) | 40文字のhex |
$hash.sha256(str) | 64文字のhex |
$hash.sha384(str) | 96文字のhex |
$hash.sha512(str) | 128文字のhex |
$hash.md5("hello"); // "5d41402abc4b2a76b9719d911017c592"
$hash.sha256("hello"); // "2cf24dba5fb0a30e26e83b2ac5b9e29e1b161e5c1fa7425e73043362938b9824"
// integrity check
const checksum = $hash.sha256(JSON.stringify({user: "admin"}));
$hmac — メッセージ認証コード
API署名と改ざん検出のための鍵付きハッシュ。(data, key) ともにUTF-8エンコードされ、小文字のhexを返します。
| メソッド | アルゴリズム |
|---|---|
$hmac.md5(data, key) | HMAC-MD5 |
$hmac.sha1(data, key) | HMAC-SHA1 |
$hmac.sha256(data, key) | HMAC-SHA256 |
$hmac.sha384(data, key) | HMAC-SHA384 |
$hmac.sha512(data, key) | HMAC-SHA512 |
const signature = $hmac.sha256("important data", "my-secret-key");
const isValid = (signature === $hmac.sha256("important data", "my-secret-key")); // true
$crypto — 対称暗号
AES-GCM認証付き暗号(推奨)とDES(レガシー互換)。
| メソッド | 返り値 |
|---|---|
$crypto.encryptAES(plaintext, password, options?) | Base64暗号文。失敗時は "Error: <reason>" 文字列を返します。 |
$crypto.decryptAES(ciphertext, password, options?) | 平文。無効な暗号文は "Error: Invalid ciphertext" を返します。 |
$crypto.encryptDES(plaintext, key) | DES-ECB + PKCS7、鍵は8バイトに切り詰め → Base64。 |
$crypto.decryptDES(ciphertext, key) | 平文。Base64でない入力は "" を返します。 |
options:{ keySize: 128 \| 192 \| 256 }(デフォルト256)。AESの暗号文形式は base64(nonce[12] + ciphertext + tag[16]) です — decryptAES とペアで使います 。他言語と相互運用する場合は、この形式を自分で展開する必要があります。
const encrypted = $crypto.encryptAES("sensitive data", "my-password");
$crypto.decryptAES(encrypted, "my-password"); // "sensitive data"
// 128-bit key
const e128 = $crypto.encryptAES("data", "pass", { keySize: 128 });
// errors are returned as strings, not thrown — check the prefix
const out = $crypto.decryptAES("not-base64!!", "p");
if (out.startsWith("Error:")) { /* handle error */ }
$jwt — JSON Web Token
認証フロースクリプト向けのJWT作成、パース、署名検証(HMAC系)。
| メソッド | 返り値 |
|---|---|
$jwt.sign(payload, secret, algorithm?) | JWT文字列。デフォルト HS256。 |
$jwt.decode(token) | {header, payload} オブジェクト(署名は検証されません)。不正なトークンは null を返します。 |
$jwt.verify(token, secret, algorithm?) | boolean — 署名検証の結果。 |
algorithm:"HS256" | "HS384" | "HS512"。
// sign
const payload = JSON.stringify({ sub: "user123", exp: Math.floor(Date.now() / 1000) + 3600 });
const token = $jwt.sign(payload, "my-secret", "HS256");
// decode — returns an object directly, no JSON.parse needed
const decoded = $jwt.decode(token);
decoded.header.alg; // "HS256"
decoded.payload.sub; // "user123"
// verify
$jwt.verify(token, "my-secret", "HS256"); // true
$jwt.verify(token, "wrong-secret", "HS256"); // false
// expiry check
const exp = $jwt.decode(token).payload.exp;
const expired = exp * 1000 < Date.now();
$format — データフォーマット
ロギングとデバッグのためのJSON/XML整形とミニファイ。出力ではJSONキーがアルファベット順にソートされます。
| メソッド | 返り値 |
|---|---|
$format.json(str, indent?) | 整形されたJSON。indentは1–8にクランプ(デフォルト2)。無効な入力は "Error: Invalid JSON" を返します。 |
$format.minify(str) | ミニファイされたJSON(キーソート済み、空白なし)。無効な入力は "Error: Invalid JSON" を返します。 |
$format.xml(str) | 単純インデントのXML。 |
$format.json('{"b":1,"a":2}');
// {
// "a": 2,
// "b": 1
// }
$format.json('{"a":2}', 4); // 4-space indent
$format.minify('{ "a": 2 }'); // '{"a":2}'
$format.xml('<root><child>t</child></root>');
// <root>
// <child>t</child>
// </root>
$fs — ファイルシステム
スクリプト内での軽量なファイル読み書き(設定、キャッシュ、エクスポート)。パスは ~ 展開に対応し、write は存在しない親ディレクトリを自動作成します。
| メソッド | 返り値 |
|---|---|
$fs.read(path) | UTF-8コンテンツ。失敗時は "Error: Cannot read file at <path>" を返します。 |
$fs.readBinary(path) | Base64としてのバイト列。失敗時は "" を返します。 |
$fs.write(path, content) | boolean — 成功したかどうか。 |
$fs.exists(path) | boolean。 |
$fs.delete(path) | boolean。存在しないファイルは false を返します。 |
$fs.list(path) | ディレクトリエントリの string[]。失敗時は [] を返します。 |
$fs.info(path) | JSON文字列 {size, modified, isDirectory, path}。存在しないパスは undefined を返します。 |
const file = $env.tmpDir() + "/hodor-test.txt";
$fs.write(file, "Hello from Hodor!");
$fs.read(file); // "Hello from Hodor!"
$fs.exists(file); // true
$fs.list($env.tmpDir()); // ["hodor-test.txt", ...]
const info = JSON.parse($fs.info(file));
info.size; // byte count
info.isDirectory; // false
$fs.delete(file); // true
失敗時の返り値の形はメソッドごとに異なります:read は "Error: ..." 文字列、readBinary は ""、list は []、info は undefined を返します — それぞれに応じて処理してください。
$env — 環境変数
プロセス環境変数とシステムパス。注意:$env はプロセス環境です(実行間で共有され、プロセスと共に存在します)。ユーザー向けの変数を永続化するには、代わりに sdk.setEnvVar または SharedPreferences を使います。
| メソッド | 返り値 |
|---|---|
$env.get(key) | 値。存在しないキーは "" を返します。 |
$env.set(key, value) | boolean — setenvの結果。 |
$env.all() | すべての環境変数のJSON文字列。 |
$env.cwd() | 現在の作業ディレクトリ。 |
$env.tmpDir() | 一時ディレクトリ。 |
$env.homeDir() | ユーザーのホームディレクトリ。 |
$env.set("APP_VERSION", "1.0.0");
$env.get("APP_VERSION"); // "1.0.0"
const all = JSON.parse($env.all());
$uuid — UUID
UUIDの生成と検証(リクエストID、冪等キー)。
| メソッド | 返り値 |
|---|---|
$uuid.v4() | 標準のv4 UUID(大文字・ハイフン付き)。例:"550e8400-E29B-41D4-A716-446655440000"。 |
$uuid.compact() | ハイフンなしの小文字形。 |
$uuid.validate(str) | 文字列が有効なUUIDかどうか。 |
const id = $uuid.v4();
$uuid.compact(); // "550e8400e29b41d4a716446655440000"
$uuid.validate($uuid.v4()); // true
$uuid.validate("not-uuid"); // false
validate が受け付けるのはハイフン付き形式のみです — validate($uuid.compact()) は false を返します。compact文字列を検証する前にハイフンを再挿入してください。
$log — 構造化ログ
タイムスタンプとレベル付きのログ行。エンジンのコンソールシステムを経由します(スクリプトのログビューに収集されます)。
| メソッド | 返り値 |
|---|---|
$log.log(level, message, tag?) | 整形されたログ行(出力もされる)。 |
$log.debug / info / warn / error(message) | レベル別の簡易メソッド。出力のみ。 |
ログ行の形式:[yyyy-MM-dd'T'HH:mm:ss.SSSZ] [LEVEL] [tag] message(tagを指定しない場合は [tag] 部分は省略されます)。
$log.info("Server started on port 8080");
// [2025-07-24T01:11:45.548+0800] [INFO] Server started on port 8080
$log.log("info", "Request processed", "API");
// [2025-07-24T01:11:45.548+0800] [INFO] [API] Request processed
Web API
fetch
スクリプトから実際のHTTPリクエストを送信します — Postmanスタイルのワークフローの主経路です。
fetch(url: string, options?: object) → Promise<response>
options:
| フィールド | 型 | デフォルト | 説明 |
|---|---|---|---|
method | string | "GET" | 大文字小文字を区別しない。不明な値はGETにフォールバック。 |
timeoutInterval | number | 30 | 秒。 |
headers | [[k, v]] または [{k: v}] | [] | どちらの形も受け付けます。 |
textBody | string | — | リクエストボディのテキスト。 |
encoding | string | — | "hex" は textBody がhex文字列であることを意味します。 |
解決値はプレーンオブジェクトです:statusCode(数値)、headers(シングルキーオブジェクトの配列、重複キーは保持)、そして textBody() — {text, encoding} を返す関数で、文字セットは自動検出されます(デコード不能なボディは {text: <hex>, encoding: "hex"} にフォールバック)。拒否値はエラーメッセージ文字列です。
// GET
const rsp = await fetch("https://httpbin.org/get");
if (rsp.statusCode === 200) {
const body = rsp.textBody(); // {text: "...", encoding: "utf-8"}
const json = JSON.parse(body.text);
}
// POST JSON
const rsp2 = await fetch("https://httpbin.org/post", {
method: "POST",
headers: [["Content-Type", "application/json"]],
textBody: JSON.stringify({a: 1}),
timeoutInterval: 10,
});
HTTPClient
HTTPClient クラスは任意のスクリプトからHTTPリクエストを送ります(fetch の上に実装)。すべてのメソッドは async で、statusCode、headers、textBody() を持つレスポンスオブジェクトを返します。
| メソッド | 説明 |
|---|---|
HTTPClient.get(url, params?) | GETリクエストを送信。 |
HTTPClient.post(url, params?) | POSTリクエストを送信。 |
HTTPClient.put(url, params?) | PUTリクエストを送信。 |
HTTPClient.update(url, params?) | UPDATEリクエストを送信。 |
HTTPClient.delete(url, params?) | DELETEリクエストを送信。 |
HTTPClient.request(url, method, params?) | カスタムメソッドでリクエストを送信。 |
params は次の内容を持つ任意のオブジェクトです:
headers:リクエストヘッダーオブジェクト。例:{"key1": "value1"}body:リクエストボディ — 文字列、JSONオブジェクト(自動シリアライズ)、または URLSearchParamstimeoutInterval:タイムアウト秒数(デフォルト60)
try {
var params = {
"headers": {"key1": "value1"},
"body": {"a": "a1", "b": "b1"},
};
const response = await HTTPClient.post("https://dummyjson.com/products/1", params);
console.log(response.textBody().text);
} catch(error) {
console.log(error);
}
タイマー
setTimeout / setInterval / clearTimeout / clearInterval はブラウザと同様に動作します。コールバックは直列のエンジンキューにディスパッチされるため、ホストスレッドに関係なくタイマーは確実に発火します。
| 関数 | 返り値 |
|---|---|
setTimeout(callback, ms) | タイマーid(文字列)。1回発火。 |
setInterval(callback, ms) | タイマーid。繰り返し発火。 |
clearTimeout(id) / clearInterval(id) | キャンセル(冪等。不明なidは無視)。 |
await new Promise(resolve => setTimeout(resolve, 500)); // wait 0.5s
const timer = setInterval(() => console.log("tick"), 1000);
setTimeout(() => clearInterval(timer), 3500);
グローバル関数
| 名前 | シグネチャ | 説明 |
|---|---|---|
btoa(str) | (string) → string | Base64エンコード — UTF-8対称セマンティクス(ブラウザと違い、非Latin1文字列も許容)。 |
atob(str) | (string) → string | Base64デコード。無効な入力は "" を返します。 |
performance.now() | () → number | エポックからのミリ秒(ページロードではない)。 |
sleep(ms) | (number) → Promise | ms 後 に解決。await sleep(1000) のように使います。 |
require(id) | (string) → any | CommonJSセマンティクス(module.exports)でスクリプトライブラリを読み込みます。キーは @libs/<key> で、スクリプトライブラリidentifier → スクリプトライブラリ名(一意)→ 組み込みライブラリの順に解決。見つからない場合は例外を投げます。 |
TextEncoder | new TextEncoder().encode(str) | UTF-8で Uint8Array にエンコード(encoding は常に "utf-8")。 |
crypto.getRandomValues(n) | (Array) → number[] | n 個のランダムUInt32値で埋めます。 |
crypto.randomUUID() | () → string | ランダムUUID(大文字・ハイフン付き)。 |
btoa("Hello"); // "SGVsbG8="
atob("SGVsbG8="); // "Hello"
btoa("中文"); // works — UTF-8 bytes are encoded
performance.now(); // 1760000000000.123
await sleep(100);
const { encode } = require("@libs/base64"); // built-in lib
const { sign } = require("@libs/sign-lib"); // your script library
new TextEncoder().encode("hi"); // Uint8Array [104, 105]
ライブラリはスクリプトモジュールマネージャーで管理します。requireキーは常に @libs/<key> です:自分のスクリプトライブラリはまずidentifierで解決され(リネームしても安定)、次に名前(一意一致)、最後に組み込みライブラリ @libs/base64 / @libs/hex が使われます。ライブラリは module.exports でエクスポートし、他のライブラリをrequireでき、存在しないキーは例外を投げます(送信前の失敗はリクエストを中断し、レスポンス後の失敗は元のレスポンスを保持)。完全なガイドは Quick Requestスクリプト、スクリプトライブラリのrequire を参照。
console
console.log / info / warn / error はスクリプトのログビューに値を出力します。複数の引数はシリアライズされるので、オブジェクトや配列を直接ログに出せます:
console.log("headers", {Accept: "application/json"}, [1, 2, 3]);
$log は構造化されたレベル付き出力を提供します($log 参照)— どちらのチャネルもHodorのスクリプトログビューに表示されます。
HTTPクラス
Request
Request クラスは onRequest / onSessionCompleted に渡されるパッケージ化されたHTTPリクエストです。
| メンバー | 型 | 説明 |
|---|---|---|
scheme | string (get / set) | リクエストのscheme。例:https。 |
host | string (get / set) | リクエストのhost。 |
port | number (get / set) | リクエストのport。 |
path | string (get / set) | リクエストのpath。 |
method | string (get / set) | HTTPメソッド。例:GET。 |
queries | URLSearchParams (get) | リクエストのクエリパラメータ。 |
headers | Headers (get) | リクエストのヘッダー。 |
body | Body (get) / string | Map | Array | URLSearchParams (set) | リクエストのボディ。 |
ヘッダーは .set() / .append() で変更する必要があります — インデックス代入(例:headers["X-Key"] = v)は無視されます。
自分でリクエストを構築することもできます:
const request = new Request({
scheme: 'https',
host: 'example.com',
port: 8080,
path: '/api',
method: 'GET',
queries: 'param1=value1¶m2=value2',
headers: [
['Content-Type', 'application/json'],
['Authorization', 'Bearer token']
],
textBody: '{"key": "value"}'
});
console.log(request.encode());
Response
Response クラスは onResponse / onSessionCompleted に渡されるHTTPレスポンスを表します。
| メンバー | 型 | 説明 |
|---|---|---|
statusCode | number (get / set) | レスポンスのステータスコード。 |
statusPhrase | string (get / set) | レスポンスのステータスフレーズ。例:OK。 |
headers | Headers (get) | レスポンスのヘッダー。 |
body | Body (get) / string | Map | Array | URLSearchParams (set) | レスポンスのボディ。 |
const response = new Response({
statusCode: 404,
statusPhrase: 'Not Found',
headers: {
'Content-Type': 'application/json',
'Cache-Control': 'no-cache'
},
textBody: '{"error": "Resource not found"}'
});
console.log(response.encode());
Body
Body クラスはHTTPリクエストまたはレスポンスのボディを表します。request.body / response.body に新しい値を代入すると、ボディ全体が置き換わります。
| メソッド | 返り値 | 説明 |
|---|---|---|
parseText() | string | null | ボディをテキストとしてパースします。 |
parseJSON() | object | null | ボディをJSONとしてパースします。 |
parseURLSearchParams() | URLSearchParams | null | ボディをURLエンコードされたパラメータとしてパースします。 |
const bodyInstance = new Body('{"user": "alice"}');
const json = bodyInstance.parseJSON();
if (json) {
console.log('User:' + json.user);
} else {
console.error('Failed to parse JSON');
}
Headers
Headers クラスはHTTPヘッダーを表します。
| メソッド | 返り値 | 説明 |
|---|---|---|
append(name, value) | void | 指定ヘッダーに値を追記します。 |
set(name, value) | void | 指定ヘッダーの値を設定(置換)します。 |
get(name) | string | null | 指定ヘッダーの値を取得します。 |
has(name) | boolean | 指定ヘッダーが存在するか確認します。 |
delete(name) | void | 指定ヘッダーを削除します。 |
forEach(callback, thisArg?) | void | 各ヘッダーに対して関数を呼び出します。 |
entries() / keys() / values() | Iterator | エントリ / キー / 値を反復します。 |
encode() | Array | ヘッダーをシリアライズ可能な形式にエンコ ードします。 |
const headers = new Headers();
headers.append('Content-Type', 'application/json');
headers.set('Content-Length', '1024');
console.log(headers.get('Content-Type')); // 'application/json'
console.log(headers.has('Authorization')); // false
headers.forEach((value, name) => {
console.log(name + ' ' + value);
});
URLSearchParams
URLSearchParams クラスはURLクエリ(またはurlencodedボディ)のパラメータを表します。
| メソッド | 返り値 | 説明 |
|---|---|---|
append(name, value) | void | 指定パラメータに値を追記します。 |
set(name, value) | void | 指定パラメータの値を設定(置換)します。 |
get(name) | string | null | 指定パラメータの値を取得します。 |
has(name) | boolean | 指定パラメータが存在するか確認します。 |
delete(name) | void | 指定パラメータを削除します。 |
forEach(callback, thisArg?) | void | 各パラメータに対して関数を呼び出します。 |
entries() / keys() / values() | Iterator | エントリ / キー / 値を反復します。 |
sort() | void | パラメータをソートします。 |
toString() | string | urlencoded文字列にシリアライズします。 |
const params = new URLSearchParams({ key1: 'value1', key2: 'value2' });
console.log(params.get('key1')); // 'value1'
console.log(params.get('key3')); // null
params.forEach((value, key) => console.log(key + ' ' + value));
SharedPreferences
SharedPreferences クラスは、スクリプト実行やアプリ再起動をまたいで保持されるローカル永続キーバリューストレージを提供します(システムのuser defaultsがバックエンド)。
| メソッド | 返り値 | 説明 |
|---|---|---|
SharedPreferences.write(key, value) | void | 値を書き込みます(string / number / boolean / object / array)。null を書き込むとキーが削除されます。 |
SharedPreferences.read(key) | any | キーに関連付けられた値を読み込みます。存在しない 場合は null。 |
SharedPreferences.write("test_key", "test_value");
const value = SharedPreferences.read("test_key");
console.log(value);
SharedPreferences.write("cfg", {a: 1}); // objects are stored directly
SharedPreferences.write("cfg", null); // deletes "cfg"
sdk — Quick Requestスクリプト
sdk(エイリアス pm)はQuick Requestの送信前/後スクリプトでのみ注入されます。アプリの変数ストレージ(環境、グローバル変数、実行時変数)をブリッジし、アサーションを収集します。APIの形はPostman風です。
| メンバー | 説明 |
|---|---|
sdk.env.get(key) | アプリで定義された環境変数を読み取ります。 |
sdk.env.set(key, value) | 環境変数を設定します(sdk.setEnvVar と同じ)。 |
sdk.setEnvVar(key, value) | 環境変数を書き込みます — 収集され、アプリへ永続化されます。 |
sdk.setVar(key, value) | 実行時(ローカル)変数を書き込みます。 |
sdk.setGlobalVar(key, value) | グローバル変数を書き込みます。 |
sdk.getVar(key) | 実行時変数を読み取ります。 |
sdk.test(name, fn) | 名前付 きアサーションブロックを実行します。失敗は収集されアプリで報告されます。 |
sdk.expect(value) | アサーションプリミティブ:toBe、toEqual、toBeTruthy。 |
sdk.jsonPath(object, path) | ドットパス検索。例:"$.data.list[0].id"。 |
sdk.utils.uuid() | crypto.randomUUID() と同じです。 |
sdk.utils.base64Encode(s) / base64Decode(s) | btoa / atob と同じです。 |
sdk.utils.md5(s) | $hash.md5 と同じです。 |
// Quick Request pre-request script: sign the request
async function onRequest(context, url, request) {
// read variables defined in the app's environment
const secret = sdk.env.get("secret") || "test-key";
sdk.expect(secret).toBeTruthy();
const ts = String(Date.now());
const bodyText = request.body && request.body.text ? request.body.text : '';
const sig = $hmac.sha256(ts + bodyText, secret);
// headers must be set via .set / .append
request.headers.set("X-Signature", sig);
request.headers.set("X-Timestamp", ts);
// persist variables back to the app
sdk.setEnvVar("lastTs", ts);
sdk.test("signature is 64 hex", () => {
sdk.expect(sig.length).toBe(64);
});
console.log("signed request for", url);
return request;
}
アサーション結果は送信前スクリプトで報告されます。レスポンス後スクリプトでは、アサーションは実行されますが結果は収集されません。
コンテキスト
RewriteContext
書き換えスクリプト(onRequest / onResponse)に渡されるコンテキストオブジェクト。
| メンバー | 型 | 説明 |
|---|---|---|
isEnableOnRequest | boolean (get) | onRequest エントリが有効かどうか。 |
isEnableOnResponse | boolean (get) | onResponse エントリが有効かどうか。 |
parameters | object (get / set) | onRequest と onResponse の間で共有されるパラメータ辞書。 |
scriptName | string (get) | スクリプトの名前。 |