Lewati ke konten utama

Referensi Script API

Hodor menjalankan skrip Anda dalam mesin JavaScript bawaan. Tergantung jenis skripnya, Hodor memanggil salah satu fungsi masuk di bawah ini pada waktu yang tepat — Anda hanya perlu mengimplementasikan logika yang Anda butuhkan. Jika Anda tidak memodifikasi apa pun, hapus fungsi masuk yang tidak digunakan untuk menghindari pemanggilan yang tidak perlu.

Objek dan kelas global yang tersedia:

KategoriNama
Fungsi masukonRequest, onResponse, onSessionCompleted, onSchedule, abort()
Modul $ native$codec, $hash, $hmac, $crypto, $jwt, $format, $fs, $env, $uuid, $log
API standar Webfetch, HTTPClient, setTimeout / setInterval, btoa / atob / sleep / require / TextEncoder / crypto, console
Kelas HTTPRequest, Response, Body, Headers, URLSearchParams
PenyimpananSharedPreferences, variabel sdk
KonteksRewriteContext, CompletedContext, ScheduleContext
tip

Gunakan console.log(...) di mana saja dalam skrip untuk memeriksa nilai — outputnya ditampilkan di tampilan log skrip.

Fungsi Masuk​

Skrip dideteksi dengan memindai deklarasi async function — jumlah parameter setiap fungsi masuk bersifat tetap (onRequest/onResponse menerima 3, onSessionCompleted menerima 4, onSchedule menerima 1). Penugasan arrow-function (let onRequest = async (...) => {}) tidak terdeteksi. Nama parameter bebas.

onRequest(context, url, request)​

Dirancang untuk Skrip Rewrite dan skrip pra-kirim Quick Request. Fungsi ini dipanggil sebelum permintaan HTTP dikirim ke server. Kembalikan request (kemungkinan sudah dimodifikasi).

ParameterTipeDeskripsi
contextRewriteContextObjek konteks.
urlstringURL permintaan HTTP.
requestRequestObjek permintaan 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)​

Dirancang untuk Skrip Rewrite dan skrip pasca-respons Quick Request. Fungsi ini dipanggil sebelum respons HTTP dikirim ke klien. Kembalikan response (kemungkinan sudah dimodifikasi).

ParameterTipeDeskripsi
contextRewriteContextObjek konteks.
urlstringURL respons HTTP.
responseResponseObjek respons 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)​

Dirancang untuk Skrip HTTP Completed. Dipanggil secara asinkron setelah respons HTTP dikembalikan, tanpa memengaruhi transmisi data antara aplikasi dan server. Berguna untuk pengumpulan dan penerusan data.

ParameterTipeDeskripsi
contextCompletedContextObjek konteks.
urlstringURL permintaan HTTP.
requestRequestObjek permintaan HTTP.
responseResponseObjek respons 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)​

Dirancang untuk Skrip Schedule. Dipanggil pada waktu pemicu terjadwal (ekspresi cron 5 atau 6 bagian didukung). Gunakan abort() untuk menghentikan loop penjadwalan.

ParameterTipeDeskripsi
contextScheduleContextObjek konteks.
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()​

Di dalam skrip kanal (onRequest / onResponse / onSchedule), panggil abort() untuk menghentikan skrip dan membatalkan eksekusi saat ini secara langsung — ia melempar AbortError yang dilaporkan Hodor kembali kepada Anda.

// ✅ correct — abort() is injected into the script scope
async function onRequest(context, url, request) {
if (url.includes("/tracking")) abort();
return request;
}
peringatan

Jangan deklarasikan onRequest(context, url, request, aborter) dengan parameter ke-4. Jumlah parameter fungsi masuk bersifat tetap — parameter ke-4 membuat masukan tidak terdeteksi.

Modul Native​

Semua modul berawalan $ disuntikkan saat runtime aktif. Mereka diimplementasikan secara native, kembali secara sinkron (kecuali disebutkan lain) dan memperlakukan input string sebagai UTF-8.

$codec — Enkode & Dekode​

Base64 / Hex / persentase URL untuk konversi protokol dan transfer data.

MetodeMengembalikan
$codec.base64Encode(str)String Base64.
$codec.base64Decode(str)String hasil dekode; input tidak valid mengembalikan "" (tidak melempar).
$codec.hexEncode(str)String hex huruf kecil.
$codec.hexDecode(str)String hasil dekode; karakter tidak valid dilewati.
$codec.urlEncode(str)String terenkode persen.
$codec.urlDecode(str)String hasil dekode; urutan tidak valid dikembalikan apa adanya.
$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 — Hash​

Perhitungan digest untuk pemeriksaan integritas, content addressing dan anonimisasi. Mengembalikan hex huruf kecil.

MetodePanjang output
$hash.md5(str)32 karakter hex
$hash.sha1(str)40 karakter hex
$hash.sha256(str)64 karakter hex
$hash.sha384(str)96 karakter hex
$hash.sha512(str)128 karakter hex
$hash.md5("hello"); // "5d41402abc4b2a76b9719d911017c592"
$hash.sha256("hello"); // "2cf24dba5fb0a30e26e83b2ac5b9e29e1b161e5c1fa7425e73043362938b9824"

// integrity check
const checksum = $hash.sha256(JSON.stringify({user: "admin"}));

$hmac — Kode Autentikasi Pesan​

Hash berkunci untuk penandatanganan API dan deteksi perubahan. Keduanya (data, key) terenkode UTF-8; mengembalikan hex huruf kecil.

MetodeAlgoritma
$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 — Enkripsi Simetris​

Enkripsi terautentikasi AES-GCM (direkomendasikan) dan DES (kompatibilitas lama).

MetodeMengembalikan
$crypto.encryptAES(plaintext, password, options?)Ciphertext Base64; kegagalan mengembalikan string "Error: <reason>".
$crypto.decryptAES(ciphertext, password, options?)Plaintext; ciphertext tidak valid mengembalikan "Error: Invalid ciphertext".
$crypto.encryptDES(plaintext, key)DES-ECB + PKCS7, kunci dipotong ke 8 byte → Base64.
$crypto.decryptDES(ciphertext, key)Plaintext; input non-Base64 mengembalikan "".

options: { keySize: 128 \| 192 \| 256 } (bawaan 256). Format ciphertext AES adalah base64(nonce[12] + ciphertext + tag[16]) — pasangkan dengan decryptAES; saat beroperasi bersama bahasa lain Anda harus membongkar format ini sendiri.

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​

Pembuatan, penguraian dan verifikasi tanda tangan JWT (keluarga HMAC) untuk skrip alur autentikasi.

MetodeMengembalikan
$jwt.sign(payload, secret, algorithm?)String JWT; bawaan HS256.
$jwt.decode(token)Objek {header, payload} (tanda tangan tidak diverifikasi); mengembalikan null untuk token yang rusak.
$jwt.verify(token, secret, algorithm?)boolean — hasil verifikasi tanda tangan.

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 — Pemformatan Data​

Pretty-print dan minifikasi JSON/XML untuk logging dan debugging. Kunci JSON diurutkan alfabetis dalam output.

MetodeMengembalikan
$format.json(str, indent?)JSON terformat rapi; indentasi dibatasi 1–8 (bawaan 2); input tidak valid mengembalikan "Error: Invalid JSON".
$format.minify(str)JSON terminifikasi (kunci terurut, tanpa spasi); input tidak valid mengembalikan "Error: Invalid JSON".
$format.xml(str)XML berindentasi sederhana.
$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 — Sistem Berkas​

Baca/tulis berkas ringan di dalam skrip (konfigurasi, cache, ekspor). Path mendukung ekspansi ~; write membuat direktori induk yang hilang secara otomatis.

MetodeMengembalikan
$fs.read(path)Konten UTF-8; kegagalan mengembalikan "Error: Cannot read file at <path>".
$fs.readBinary(path)Byte sebagai Base64; kegagalan mengembalikan "".
$fs.write(path, content)boolean — berhasil.
$fs.exists(path)boolean.
$fs.delete(path)boolean; berkas yang hilang mengembalikan false.
$fs.list(path)string[] entri direktori; kegagalan mengembalikan [].
$fs.info(path)String JSON {size, modified, isDirectory, path}; path yang hilang mengembalikan 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
catatan

Bentuk kegagalan berbeda per metode: read mengembalikan string "Error: ...", readBinary mengembalikan "", list mengembalikan [] dan info mengembalikan undefined — tangani masing-masing sesuai kebutuhannya.

$env — Variabel Lingkungan​

Variabel lingkungan proses dan path sistem. Catatan: $env adalah lingkungan proses (dibagikan antar eksekusi, hidup bersama proses). Untuk mempersistenkan variabel yang menghadap pengguna gunakan sdk.setEnvVar atau SharedPreferences.

MetodeMengembalikan
$env.get(key)Nilai; kunci yang hilang mengembalikan "".
$env.set(key, value)boolean — hasil setenv.
$env.all()String JSON semua variabel lingkungan.
$env.cwd()Direktori kerja saat ini.
$env.tmpDir()Direktori sementara.
$env.homeDir()Direktori home pengguna.
$env.set("APP_VERSION", "1.0.0");
$env.get("APP_VERSION"); // "1.0.0"
const all = JSON.parse($env.all());

$uuid — UUID​

Menghasilkan dan memvalidasi UUID (ID permintaan, kunci idempotensi).

MetodeMengembalikan
$uuid.v4()UUID v4 standar (huruf besar, bertire), mis. "550e8400-E29B-41D4-A716-446655440000".
$uuid.compact()Bentuk tanpa tire, huruf kecil.
$uuid.validate(str)Apakah string merupakan UUID yang valid.
const id = $uuid.v4();
$uuid.compact(); // "550e8400e29b41d4a716446655440000"
$uuid.validate($uuid.v4()); // true
$uuid.validate("not-uuid"); // false
catatan

validate hanya menerima format bertire — validate($uuid.compact()) mengembalikan false. Sisipkan kembali tire sebelum memvalidasi string compact.

$log — Logging Terstruktur​

Baris log bertanda waktu dan berlevel, dialirkan melalui sistem konsol mesin (dikumpulkan ke tampilan log skrip).

MetodeMengembalikan
$log.log(level, message, tag?)Baris log terformat (juga dicetak).
$log.debug / info / warn / error(message)Metode level praktis, hanya output.

Format baris log: [yyyy-MM-dd'T'HH:mm:ss.SSSZ] [LEVEL] [tag] message (bagian [tag] dihilangkan bila tidak ada 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​

Kirim permintaan HTTP sungguhan dari skrip — kanal utama untuk alur kerja bergaya Postman.

fetch(url: string, options?: object) → Promise<response>

options:

BidangTipeBawaanDeskripsi
methodstring"GET"Tidak peka huruf besar/kecil; nilai tak dikenal jatuh ke GET.
timeoutIntervalnumber30Dalam detik.
headers[[k, v]] atau [{k: v}][]Kedua bentuk diterima.
textBodystring—Teks body permintaan.
encodingstring—"hex" berarti textBody adalah string hex.

Nilai yang diselesaikan adalah objek biasa: statusCode (number), headers (array objek berkunci tunggal, kunci duplikat dipertahankan), dan textBody() — fungsi yang mengembalikan {text, encoding} dengan deteksi charset otomatis (body yang tak terdekode jatuh ke {text: <hex>, encoding: "hex"}). Nilai yang ditolak adalah string pesan galat.

// 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​

Kelas HTTPClient mengirim permintaan HTTP dari skrip apa pun (diimplementasikan di atas fetch). Semua metode async dan mengembalikan objek respons dengan statusCode, headers dan textBody().

MetodeDeskripsi
HTTPClient.get(url, params?)Kirim permintaan GET.
HTTPClient.post(url, params?)Kirim permintaan POST.
HTTPClient.put(url, params?)Kirim permintaan PUT.
HTTPClient.update(url, params?)Kirim permintaan UPDATE.
HTTPClient.delete(url, params?)Kirim permintaan DELETE.
HTTPClient.request(url, method, params?)Kirim permintaan dengan metode khusus.

params adalah objek opsional dengan:

  • headers: objek header permintaan, mis. {"key1": "value1"}
  • body: body permintaan — string, objek JSON (diserialisasi otomatis) atau URLSearchParams
  • timeoutInterval: waktu tunggu dalam detik (bawaan 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);
}

Timer​

setTimeout / setInterval / clearTimeout / clearInterval bekerja seperti di browser. Callback dikirim pada antrean mesin serial, sehingga timer terpicu andal tidak tergantung thread host.

FungsiMengembalikan
setTimeout(callback, ms)ID timer (string), terpicu sekali.
setInterval(callback, ms)ID timer, terpicu berulang.
clearTimeout(id) / clearInterval(id)Batalkan (idempoten, ID tak dikenal diabaikan).
await new Promise(resolve => setTimeout(resolve, 500)); // wait 0.5s
const timer = setInterval(() => console.log("tick"), 1000);
setTimeout(() => clearInterval(timer), 3500);

Fungsi Global​

NamaSignatureDeskripsi
btoa(str)(string) → stringEnkode Base64 — semantik simetris UTF-8 (string non-Latin1 diizinkan, tidak seperti browser).
atob(str)(string) → stringDekode Base64; input tidak valid mengembalikan "".
performance.now()() → numberMilidetik sejak epoch (bukan pemuatan halaman).
sleep(ms)(number) → PromiseSelesai setelah ms; gunakan await sleep(1000).
require(id)(string) → anyMemuat pustaka skrip dengan semantik CommonJS (module.exports); kuncinya @libs/<key>, diselesaikan sebagai identifier pustaka skrip → nama pustaka skrip (unik) → pustaka bawaan; melempar galat saat tidak ditemukan.
TextEncodernew TextEncoder().encode(str)Enkode UTF-8 ke dalam Uint8Array (encoding selalu "utf-8").
crypto.getRandomValues(n)(Array) → number[]Mengisi dengan n nilai UInt32 acak.
crypto.randomUUID()() → stringUUID acak (huruf besar, bertire).
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]

Pustaka dikelola di manajer modul skrip. Kunci require selalu @libs/<key>: pustaka skrip Anda diselesaikan berdasarkan identifier terlebih dahulu (stabil lintas penggantian nama), lalu berdasarkan nama (cocok unik), lalu pustaka bawaan @libs/base64 / @libs/hex. Pustaka mengekspor melalui module.exports, dapat me-require pustaka lain, dan kunci yang hilang melempar galat (kegagalan pra-kirim membatalkan permintaan, kegagalan pasca-respons mempertahankan respons asli). Lihat Quick Request scripting, Memuat Pustaka Skrip dengan require() untuk panduan lengkap.

console​

console.log / info / warn / error mencetak nilai ke tampilan log skrip. Beberapa argumen diserialisasi, sehingga Anda bisa langsung mencatat objek dan array:

console.log("headers", {Accept: "application/json"}, [1, 2, 3]);

$log menawarkan output terstruktur berlevel (lihat $log) — kedua kanal terlihat di tampilan log skrip Hodor.

Kelas HTTP​

Request​

Kelas Request adalah permintaan HTTP terpaket yang diteruskan ke onRequest / onSessionCompleted.

AnggotaTipeDeskripsi
schemestring (get / set)Skema permintaan, mis. https.
hoststring (get / set)Host permintaan.
portnumber (get / set)Port permintaan.
pathstring (get / set)Path permintaan.
methodstring (get / set)Metode HTTP, mis. GET.
queriesURLSearchParams (get)Parameter query permintaan.
headersHeaders (get)Header permintaan.
bodyBody (get) / string | Map | Array | URLSearchParams (set)Body permintaan.
catatan

Header harus dimodifikasi dengan .set() / .append() — penugasan indeks (mis. headers["X-Key"] = v) diabaikan.

Anda juga bisa membuat permintaan sendiri:

const request = new Request({
scheme: 'https',
host: 'example.com',
port: 8080,
path: '/api',
method: 'GET',
queries: 'param1=value1&param2=value2',
headers: [
['Content-Type', 'application/json'],
['Authorization', 'Bearer token']
],
textBody: '{"key": "value"}'
});
console.log(request.encode());

Response​

Kelas Response merepresentasikan respons HTTP yang diteruskan ke onResponse / onSessionCompleted.

AnggotaTipeDeskripsi
statusCodenumber (get / set)Kode status respons.
statusPhrasestring (get / set)Frasa status respons, mis. OK.
headersHeaders (get)Header respons.
bodyBody (get) / string | Map | Array | URLSearchParams (set)Body respons.
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​

Kelas Body merepresentasikan body permintaan atau respons HTTP. Menugaskan nilai baru ke request.body / response.body menggantikan seluruh body.

MetodeMengembalikanDeskripsi
parseText()string | nullMengurai body sebagai teks.
parseJSON()object | nullMengurai body sebagai JSON.
parseURLSearchParams()URLSearchParams | nullMengurai body sebagai parameter terenkode 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​

Kelas Headers merepresentasikan header HTTP.

MetodeMengembalikanDeskripsi
append(name, value)voidMenambahkan nilai ke header yang ditentukan.
set(name, value)voidMengatur (mengganti) nilai header yang ditentukan.
get(name)string | nullMendapatkan nilai header yang ditentukan.
has(name)booleanMemeriksa apakah header yang ditentukan ada.
delete(name)voidMenghapus header yang ditentukan.
forEach(callback, thisArg?)voidMemanggil fungsi untuk setiap header.
entries() / keys() / values()IteratorIterasi atas entri / kunci / nilai.
encode()ArrayMenenkode header ke format yang dapat diserialisasi.
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​

Kelas URLSearchParams merepresentasikan parameter query URL (atau body terenkode URL).

MetodeMengembalikanDeskripsi
append(name, value)voidMenambahkan nilai ke parameter yang ditentukan.
set(name, value)voidMengatur (mengganti) nilai parameter yang ditentukan.
get(name)string | nullMendapatkan nilai parameter yang ditentukan.
has(name)booleanMemeriksa apakah parameter yang ditentukan ada.
delete(name)voidMenghapus parameter yang ditentukan.
forEach(callback, thisArg?)voidMemanggil fungsi untuk setiap parameter.
entries() / keys() / values()IteratorIterasi atas entri / kunci / nilai.
sort()voidMengurutkan parameter.
toString()stringMenyerialisasi menjadi string terenkode URL.
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​

Kelas SharedPreferences menyediakan penyimpanan kunci-nilai persisten lokal yang bertahan antar eksekusi skrip dan restart aplikasi (didukung oleh user defaults sistem).

MetodeMengembalikanDeskripsi
SharedPreferences.write(key, value)voidMenulis nilai (string / number / boolean / object / array). Menulis null menghapus kunci.
SharedPreferences.read(key)anyMembaca nilai yang terkait dengan kunci, atau null bila tidak ada.
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 — Skrip Quick Request​

sdk (alias pm) disuntikkan hanya di skrip pra/pasca Quick Request. Ia menjembatani penyimpanan variabel aplikasi (lingkungan, variabel global dan runtime) dan mengumpulkan assertion, dengan bentuk API mirip Postman.

AnggotaDeskripsi
sdk.env.get(key)Membaca variabel lingkungan yang didefinisikan di aplikasi.
sdk.env.set(key, value)Mengatur variabel lingkungan (sama dengan sdk.setEnvVar).
sdk.setEnvVar(key, value)Menulis variabel lingkungan — dikumpulkan dan dipersistenkan kembali ke aplikasi.
sdk.setVar(key, value)Menulis variabel runtime (lokal).
sdk.setGlobalVar(key, value)Menulis variabel global.
sdk.getVar(key)Membaca variabel runtime.
sdk.test(name, fn)Menjalankan blok assertion bernama; kegagalan dikumpulkan dan dilaporkan di aplikasi.
sdk.expect(value)Primitif assertion: toBe, toEqual, toBeTruthy.
sdk.jsonPath(object, path)Pencarian dot-path, mis. "$.data.list[0].id".
sdk.utils.uuid()Sama dengan crypto.randomUUID().
sdk.utils.base64Encode(s) / base64Decode(s)Sama dengan btoa / atob.
sdk.utils.md5(s)Sama dengan $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;
}
catatan

Hasil assertion dilaporkan untuk skrip pra-kirim. Di skrip pasca-respons, assertion berjalan tetapi hasilnya tidak dikumpulkan.

Konteks​

RewriteContext​

Objek konteks yang diteruskan ke skrip rewrite (onRequest / onResponse).

AnggotaTipeDeskripsi
isEnableOnRequestboolean (get)Apakah masukan onRequest diaktifkan.
isEnableOnResponseboolean (get)Apakah masukan onResponse diaktifkan.
parametersobject (get / set)Kamus parameter yang dibagikan antara onRequest dan onResponse.
scriptNamestring (get)Nama skrip.

CompletedContext​

Objek konteks yang diteruskan ke skrip HTTP completed.

AnggotaTipeDeskripsi
sessionobject (get)Objek sesi yang terkait dengan skrip completed.
scriptNamestring (get)Nama skrip completed.

ScheduleContext​

Objek konteks yang diteruskan ke skrip schedule.

AnggotaTipeDeskripsi
parametersobject (get / set)Parameter yang diteruskan ke runloop berikutnya saat diatur.
cronstring (get)Ekspresi cron penjadwalan.
repeatedCountnumber (get)Berapa kali skrip telah diulang.
scriptNamestring (get)Nama skrip terjadwal.

Catatan Perilaku​

  • Pengecualian tak tertangkap menggagalkan skrip. Galat (termasuk AbortError dari abort()) merambat ke Hodor dan eksekusi dilaporkan gagal — penulisan ulang parsial sebelum galat dibuang, jadi lindungi blok berisiko dengan try / catch.
  • Watchdog waktu tunggu. Setiap eksekusi skrip memiliki anggaran waktu; skrip yang tak pernah selesai (mis. loop tak berujung atau await yang menggantung) dipaksa berhenti dan dilaporkan sebagai timeout.
  • Galat sebagai nilai kembalian. Beberapa API tidak pernah melempar: $codec.base64Decode mengembalikan "", $crypto mengembalikan string "Error: ...", $fs.read mengembalikan string "Error: ..." dan $fs.info mengembalikan undefined. Periksa nilai kembalian ini daripada mengandalkan try / catch.
  • console.log vs $log. Keduanya terlihat di tampilan log skrip; $log menambahkan tanda waktu dan level.
  • Persistensi runtime skrip. Variabel yang ditulis dengan sdk.setVar dan berkas yang ditulis dengan $fs tetap tersedia untuk eksekusi skrip yang sama berikutnya; SharedPreferences bertahan antar restart aplikasi.