Перейти к основному содержимому

Справочник API скриптов

Hodor выполняет ваши скрипты во встроенном JavaScript-движке. В зависимости от типа скрипта Hodor вызывает одну из функций входа ниже в нужный момент — вы реализуете только нужную логику. Если вы ничего не изменяете, удалите неиспользуемую функцию входа, чтобы избежать лишних вызовов.

Доступные глобальные объекты и классы:

КатегорияИмена
Функции входаonRequest, onResponse, onSessionCompleted, onSchedule, abort()
Нативные $-модули$codec, $hash, $hmac, $crypto, $jwt, $format, $fs, $env, $uuid, $log
Стандартные Web APIfetch, 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.

ПараметрТипОписание
contextRewriteContextОбъект контекста.
urlstringURL HTTP-запроса.
requestRequestОбъект 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.

ПараметрТипОписание
contextRewriteContextОбъект контекста.
urlstringURL HTTP-ответа.
responseResponseОбъект 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-ответа, не влияя на передачу данных между приложением и сервером. Полезна для сбора и пересылки данных.

ПараметрТипОписание
contextCompletedContextОбъект контекста.
urlstringURL HTTP-запроса.
requestRequestОбъект HTTP-запроса.
responseResponseОбъект 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(), чтобы остановить цикл расписания.

ПараметрТипОписание
contextScheduleContextОбъект контекста.
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;
}
warning

Не объявляйте onRequest(context, url, request, aborter) с четвертым параметром. Количество параметров функций входа фиксировано — четвертый параметр делает точку входа необнаружимой.

Нативные модули​

Все модули с префиксом $ внедряются при активации рантайма. Они реализованы нативно, возвращают синхронно (если не указано иное) и трактуют строковые входы как UTF-8.

$codec — Кодирование и декодирование​

Base64 / Hex / URL percent-кодирование для преобразования протоколов и передачи данных.

МетодВозвращает
$codec.base64Encode(str)Строку Base64.
$codec.base64Decode(str)Декодированную строку; неверный вход возвращает "" (не бросает).
$codec.hexEncode(str)Строку строчного hex.
$codec.hexDecode(str)Декодированную строку; неверные символы пропускаются.
$codec.urlEncode(str)Percent-кодированную строку.
$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?)Plaintext; неверный шифротекст возвращает "Error: Invalid ciphertext".
$crypto.encryptDES(plaintext, key)DES-ECB + PKCS7, ключ усекается до 8 байт → Base64.
$crypto.decryptDES(ciphertext, key)Plaintext; не-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 (отсортированные ключи, без whitespace); неверный вход возвращает "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. Перед валидацией compact-строки вставьте дефисы обратно.

$log — Структурированное логирование​

Журнальные строки с timestamp и уровнем, маршрутизируемые через консольную систему движка (собираются в журнале скрипта).

МетодВозвращает
$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:

ПолеТипПо умолчаниюОписание
methodstring"GET"Без учета регистра; неизвестные значения откатываются к GET.
timeoutIntervalnumber30Секунды.
headers[[k, v]] или [{k: v}][]Принимаются обе формы.
textBodystring—Текст тела запроса.
encodingstring—"hex" означает, что textBody — hex-строка.

Разрешенное значение — простой объект: statusCode (number), 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-объект (сериализуется автоматически) или URLSearchParams
  • timeoutInterval: таймаут в секундах (по умолчанию 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 таймера (string), срабатывает один раз.
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>, разрешается как идентификатор библиотеки скриптов → имя библиотеки скриптов (уникальное) → встроенные библиотеки; бросает, если не найдено.
TextEncodernew 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, могут подключать другие библиотеки, а отсутствующий ключ бросает (сбои перед отправкой прерывают запрос, сбои после ответа сохраняют оригинальный ответ). Полное руководство см. в scripting Quick Request, Подключение библиотек скриптов.

console​

console.log / info / warn / error печатает значения в журнале скрипта. Несколько аргументов сериализуются, так что объекты и массивы можно логировать напрямую:

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

$log предлагает структурированный вывод с уровнями (см. $log) — оба канала видны в журнале скрипта Hodor.

HTTP-классы​

Request​

Класс Request — упакованный HTTP-запрос, передаваемый в onRequest / onSessionCompleted.

ЧленТипОписание
schemestring (get / set)Схема запроса, например https.
hoststring (get / set)Хост запроса.
portnumber (get / set)Порт запроса.
pathstring (get / set)Путь запроса.
methodstring (get / set)HTTP-метод, например GET.
queriesURLSearchParams (get)Параметры запроса.
headersHeaders (get)Заголовки запроса.
bodyBody (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&param2=value2',
headers: [
['Content-Type', 'application/json'],
['Authorization', 'Bearer token']
],
textBody: '{"key": "value"}'
});
console.log(request.encode());

Response​

Класс Response представляет HTTP-ответ, передаваемый в onResponse / onSessionCompleted.

ЧленТипОписание
statusCodenumber (get / set)Код состояния ответа.
statusPhrasestring (get / set)Фраза состояния ответа, например OK.
headersHeaders (get)Заголовки ответа.
bodyBody (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) внедряется только в скрипты pre/post Quick Request. Он мост к хранилищу переменных приложения (окружения, глобальные и runtime-переменные) и собирает проверки, с формой API в стиле Postman.

ЧленОписание
sdk.env.get(key)Читает переменную окружения, определенную в приложении.
sdk.env.set(key, value)Задает переменную окружения (то же, что sdk.setEnvVar).
sdk.setEnvVar(key, value)Записывает переменную окружения — собирается и сохраняется обратно в приложение.
sdk.setVar(key, value)Записывает runtime-(локальную) переменную.
sdk.setGlobalVar(key, value)Записывает глобальную переменную.
sdk.getVar(key)Читает runtime-переменную.
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​

Объект контекста, передаваемый в rewrite-скрипты (onRequest / onResponse).

ЧленТипОписание
isEnableOnRequestboolean (get)Включена ли точка входа onRequest.
isEnableOnResponseboolean (get)Включена ли точка входа onResponse.
parametersobject (get / set)Словарь параметров, разделяемый между onRequest и onResponse.
scriptNamestring (get)Имя скрипта.

CompletedContext​

Объект контекста, передаваемый в HTTP completed-скрипты.

ЧленТипОписание
sessionobject (get)Объект сессии, связанный с completed-скриптом.
scriptNamestring (get)Имя completed-скрипта.

ScheduleContext​

Объект контекста, передаваемый в schedule-скрипты.

ЧленТипОписание
parametersobject (get / set)Параметры, передаваемые следующему циклу при задании.
cronstring (get)Cron-выражение расписания.
repeatedCountnumber (get)Сколько раз скрипт повторился.
scriptNamestring (get)Имя schedule-скрипта.

Примечания о поведении​

  • Необработанные исключения ломают скрипт. Ошибки (включая AbortError от abort()) доходят до Hodor, и выполнение сообщается как провал — частичные переписывания до ошибки отбрасываются, поэтому защищайте рискованные блоки try / catch.
  • Сторож таймаута. У каждого запуска скрипта есть бюджет времени; скрипт, который никогда не завершается (например бесконечный цикл или зависший await), принудительно прерывается и сообщается как таймаут.
  • Ошибки как возвращаемые значения. Некоторые API никогда не бросают: $codec.base64Decode возвращает "", $crypto возвращает строки "Error: ...", $fs.read возвращает строки "Error: ...", а $fs.info возвращает undefined. Проверяйте эти возвращаемые значения вместо опоры на try / catch.
  • console.log vs $log. Оба видны в журнале скрипта; $log добавляет timestamps и уровни.
  • Сохраняемость рантайма скриптов. Переменные, записанные sdk.setVar, и файлы, записанные $fs, остаются доступны последующим выполнениям того же скрипта; SharedPreferences переживает перезапуски приложения.