Довідник Script API
Hodor виконує ваші скрипти у вбудованому рушії JavaScript. Залежно від типу скрипта Hodor викликає одну з наведених нижче функцій входу у відповідний момент — ви реалізуєте лише потрібну логіку. Якщо нічого не змінюєте, видаліть невикористану функцію входу, щоб уникнути зайвих викликів.
Доступні глобальні об'єкти та класи:
| Категорія | Назви |
|---|---|
| Функції входу | onRequest, onResponse, onSessionCompleted, onSchedule, abort() |
Нативні $-модулі | $codec, $hash, $hmac, $crypto, $jwt, $format, $fs, $env, $uuid, $log |
| Стандартні веб-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)
Призначено для Rewrite Script та скриптів перед відправленням Quick Request. Викликається пере д надсиланням HTTP-запиту на сервер. Повертайте (можливо, змінений) request.
| Параметр | Тип | Опис |
|---|---|---|
context | RewriteContext | Об'єкт контексту. |
url | string | URL HTTP-запиту. |
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)
Призначено для Rewrite Script та скриптів після відповіді Quick Request. Викликається перед надсиланням HTTP-відповіді клієнту. Повертайте (можливо, змінену) response.
| Параметр | Тип | Опис |
|---|---|---|
context | RewriteContext | Об'єкт контексту. |
url | string | URL HTTP-відповіді. |
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 Script. Викликається асинхронно після повернення HTTP-відповіді, не впливаючи на передавання даних між застосунком і сервером. Зручно для збирання та пересилання даних.
| Параметр | Тип | Опис |
|---|---|---|
context | CompletedContext | Об'єкт контексту. |
url | string | URL HTTP-запиту. |
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)
Призначено для Schedule Script. Викликається в запланований момент спрацювання (підтримуються cron-вирази з 5 або 6 частин). Використовуйте 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) з четвертим параметром. Кількість параметрів функцій входу фіксована — четвертий параметр робить вхід невиявним.
Нативні модулі
Усі модулі з префіксом $ впорскуються під час активації середовища виконання. Вони реалізовані нативно, повертають синхронно (якщо не зазначено інше) і трактують рядкові входи як 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; відступ обмежено 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 (ідентифікатори запитів, ключі ідемпотентності).
| Метод | Повертає |
|---|---|
$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. Перед перевіркою компактного рядка вставте дефіси назад.
$log — Структуроване журналювання
Рядки журналу з мітками часу та рівнями, спрямовані через консольну систему рушія (збираються у поданні журналу скрипта).
| Метод | Повертає |
|---|---|
$log.log(level, message, tag?) | Відформатований рядок журналу (також друкується). |
$log.debug / info / warn / error(message) | Зручні методи рівнів, лише вивід. |
Формат рядка журналу: [yyyy-MM-dd'T'HH:mm:ss.SSSZ] [LEVEL] [tag] message (сегмент [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
Веб-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) | Ідентифікатор таймера (рядок), спрацьовує один раз. |
setInterval(callback, ms) | Ідентифікатор таймера, спрацьовує повторно. |
clearTimeout(id) / clearInterval(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>, розв'язується як ідентифікатор бібліотеки скриптів → назва бібліотеки скриптів (унікальна) → вбудовані бібліотеки; кидає виняток, якщо не знайдено. |
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>: ваші бібліотеки скриптів розв'язуються спершу за ідентифікатором (стабільним під час перейменувань), потім за назвою (унікальний збіг), потім вбудовані бібліотеки @libs/base64 / @libs/hex. Бібліотеки експортують через module.exports, можуть require інші бібліотеки, а відсутній ключ кидає виняток (невдачі перед відправленням переривають запит, невдачі після відповіді зберігають оригінальну відповідь). Повний посібник: Quick Request scripting, Завантаження бібліотек скриптів через require().
console
console.log / info / warn / error друкує значення у поданні журналу скрипта. Кілька аргументів сералізуються, тож об'єкти та масиви можна журналювати безпосередньо:
console.log("headers", {Accept: "application/json"}, [1, 2, 3]);
$log пропонує структурований вивід з рівнями (див. $log) — обидва канали видимі у поданні журналу скрипта Hodor.
HTTP-класи
Request
Клас Request — запакований HTTP-запит, який передається до onRequest / onSessionCompleted.
| Член | Тип | Опис |
|---|---|---|
scheme | string (get / set) | Схема запиту, напр. https. |
host | string (get / set) | Хост запиту. |
port | number (get / set) | Порт запиту. |
path | string (get / set) | Шлях запиту. |
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 представляє HTTP-відповідь, яка передається до onResponse / onSessionCompleted.
| Член | Тип | Опис |
|---|---|---|
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 надає локальне постійне сховище ключ-значення, яке переживає виконання скриптів і перезапуски застосунку (спирається на системні налаштування користувача).
| Метод | Повертає | Опис |
|---|---|---|
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. Він з'єднує сховище змінних застосунку (середовища, глобальні та змінні часу виконання), збирає assertion та має форму 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) | Виконайте іменований блок assertion; невдачі збираються та повідомляються в застосунку. |
sdk.expect(value) | Примітиви assertion: 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;
}
Результати assertion повідомляються для скриптів перед відправленням. У скриптах після відповіді assertion виконуються, ал е результати не збираються.
Контексти
RewriteContext
Об'єкт контексту, який передається скриптам перезапису (onRequest / onResponse).
| Член | Тип | Опис |
|---|---|---|
isEnableOnRequest | boolean (get) | Чи ввімкнено вхід onRequest. |
isEnableOnResponse | boolean (get) | Чи ввімкнено вхід onResponse. |
parameters | object (get / set) | Словник параметрів, спільний між onRequest та onResponse. |
scriptName | string (get) | Назва скрипта. |
CompletedContext
Об'єкт контексту, який передається скриптам завершення HTTP.
| Член | Тип | Опис |
|---|---|---|
session | object (get) | Об'єкт сеансу, пов'язаний зі скриптом завершення. |
scriptName | string (get) | Назва скрипта завершення. |
ScheduleContext
Об'єкт контексту, який передається скриптам розкладу.
| Член | Тип | Опис |
|---|---|---|
parameters | object (get / set) | Параметри, що передаються до наступного циклу виконання після встановлення. |
cron | string (get) | Cron-вираз розкладу. |
repeatedCount | number (get) | Скільки разів скрипт повторено. |
scriptName | string (get) | Назва запланованого скрипта. |
Примітки до поведінки
- Невловлені винятки роблять скрипт невдалим. Помилки (включно з
AbortErrorвідabort()) поширюються до Hodor, і виконання повідомляється як невдале — часткові перезаписи, зро блені до помилки, відкидаються, тож захищайте ризикові блоки черезtry / catch. - Вартовий таймауту. Кожне виконання скрипта має бюджет часу; скрипт, що ніколи не завершується (напр. нескінченний цикл або завислий
await), примусово переривається та повідомляється як таймаут. - Помилки як значення повернення. Деякі API ніколи не кидають винятків:
$codec.base64Decodeповертає"",$cryptoповертає рядки"Error: ...",$fs.readповертає рядки"Error: ...", а$fs.infoповертаєundefined. Перевіряйте ці значення повернення замість покладання наtry / catch. console.logvs$log. Обидва видимі у поданні журналу скрипта;$logдодає мітки часу та рівні.- Сталість середовища виконання скриптів. Змінні, записані через
sdk.setVar, і файли, записані через$fs, залишаються доступними для наступних виконань того самого скрипта;SharedPreferencesпереживає перезапуски застосунку.