Ana içeriğe geç

Script API Referansı

Hodor, script'lerinizi yerleşik bir JavaScript motorunda çalıştırır. Script türüne bağlı olarak Hodor, doğru zamanda aşağıdaki giriş fonksiyonlarından birini çağırır — yalnızca ihtiyacınız olan mantığı uygularsınız. Hiçbir şeyi değiştirmiyorsanız, gereksiz çağrıları önlemek için kullanılmayan giriş fonksiyonunu silin.

Kullanılabilir global nesneler ve sınıflar:

KategoriAdlar
Giriş fonksiyonlarıonRequest, onResponse, onSessionCompleted, onSchedule, abort()
Yerleşik $ modülleri$codec, $hash, $hmac, $crypto, $jwt, $format, $fs, $env, $uuid, $log
Web standart API'lerifetch, HTTPClient, setTimeout / setInterval, btoa / atob / sleep / require / TextEncoder / crypto, console
HTTP sınıflarıRequest, Response, Body, Headers, URLSearchParams
DepolamaSharedPreferences, sdk değişkenleri
BağlamlarRewriteContext, CompletedContext, ScheduleContext
ipucu

Script'in herhangi bir yerinde değerleri incelemek için console.log(...) kullanın — çıktı, script'in log görünümünde gösterilir.

Giriş Fonksiyonları​

Script'ler async function bildirimleri taranarak tespit edilir — her giriş fonksiyonunun parametre sayısı sabittir (onRequest/onResponse 3 alır, onSessionCompleted 4 alır, onSchedule 1 alır). Arrow-function atamaları (let onRequest = async (...) => {}) tespit edilmez. Parametre adları serbesttir.

onRequest(context, url, request)​

Rewrite Script ve Quick Request gönderim öncesi script'leri için tasarlanmıştır. Bu fonksiyon, HTTP isteği sunucuya gönderilmeden önce çağrılır. (Muhtemelen değiştirilmiş) request değerini döndürün.

ParametreTürAçıklama
contextRewriteContextBağlam nesnesi.
urlstringHTTP isteğinin URL'si.
requestRequestHTTP istek nesnesi.
// 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 ve Quick Request yanıt sonrası script'leri için tasarlanmıştır. Bu fonksiyon, HTTP yanıtı istemciye gönderilmeden önce çağrılır. (Muhtemelen değiştirilmiş) response değerini döndürün.

ParametreTürAçıklama
contextRewriteContextBağlam nesnesi.
urlstringHTTP yanıtının URL'si.
responseResponseHTTP yanıt nesnesi.
// 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 için tasarlanmıştır. HTTP yanıtı döndürüldükten sonra eşzamansız olarak çağrılır, uygulama ile sunucu arasındaki veri iletimini etkilemez. Veri toplama ve iletme için kullanışlıdır.

ParametreTürAçıklama
contextCompletedContextBağlam nesnesi.
urlstringHTTP isteğinin URL'si.
requestRequestHTTP istek nesnesi.
responseResponseHTTP yanıt nesnesi.
// 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 için tasarlanmıştır. Zamanlanmış tetikleme anında çağrılır (5 veya 6 bölümlü cron ifadeleri desteklenir). Zamanlama döngüsünü durdurmak için abort() kullanın.

ParametreTürAçıklama
contextScheduleContextBağlam nesnesi.
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()​

Kanal script'lerinin içinde (onRequest / onResponse / onSchedule), script'i durdurmak ve mevcut yürütmeyi derhal iptal etmek için abort() çağırın — Hodor'un size geri bildirdiği bir AbortError fırlatır.

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

onRequest(context, url, request, aborter) şeklinde 4. parametreli bir bildirim yapmayın. Giriş fonksiyonlarının parametre sayısı sabittir — 4. parametre, girişin tespit edilemez olmasına neden olur.

Yerleşik Modüller​

$ önekli tüm modüller, çalışma zamanı etkinleştiğinde enjekte edilir. Yerel olarak uygulanırlar, (belirtilmedikçe) eşzamanlı dönerler ve dize girişlerini UTF-8 olarak işlerler.

$codec — Kodlama ve Kod Çözme​

Protokol dönüşümü ve veri aktarımı için Base64 / Hex / URL yüzde kodlaması.

YöntemDöndürür
$codec.base64Encode(str)Base64 dizesi.
$codec.base64Decode(str)Çözülmüş dize; geçersiz girişte "" döndürür (fırlatmaz).
$codec.hexEncode(str)Küçük harfli hex dizesi.
$codec.hexDecode(str)Çözülmüş dize; geçersiz karakterler atlanır.
$codec.urlEncode(str)Yüzde kodlu dize.
$codec.urlDecode(str)Çözülmüş dize; geçersiz diziler olduğu gibi döndürülür.
$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 — Özetleme​

Bütünlük kontrolleri, içerik adresleme ve anonimleştirme için özet hesaplama. Küçük harfli hex döndürür.

YöntemÇıktı uzunluğu
$hash.md5(str)32 hex karakter
$hash.sha1(str)40 hex karakter
$hash.sha256(str)64 hex karakter
$hash.sha384(str)96 hex karakter
$hash.sha512(str)128 hex karakter
$hash.md5("hello"); // "5d41402abc4b2a76b9719d911017c592"
$hash.sha256("hello"); // "2cf24dba5fb0a30e26e83b2ac5b9e29e1b161e5c1fa7425e73043362938b9824"

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

$hmac — Mesaj Kimlik Doğrulama Kodu​

API imzalama ve kurcalama tespiti için anahtarlı özetleme. (data, key) ikisi de UTF-8 kodludur; küçük harfli hex döndürür.

YöntemAlgoritma
$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 — Simetrik Şifreleme​

AES-GCM kimlik doğrulamalı şifreleme (önerilen) ve DES (eski uyumluluk).

YöntemDöndürür
$crypto.encryptAES(plaintext, password, options?)Base64 ciphertext; başarısızlıkta "Error: <reason>" dizesi döndürür.
$crypto.decryptAES(ciphertext, password, options?)Düz metin; geçersiz ciphertext "Error: Invalid ciphertext" döndürür.
$crypto.encryptDES(plaintext, key)DES-ECB + PKCS7, anahtar 8 bayta kısaltılır → Base64.
$crypto.decryptDES(ciphertext, key)Düz metin; Base64 olmayan giriş "" döndürür.

options: { keySize: 128 \| 192 \| 256 } (varsayılan 256). AES ciphertext biçimi base64(nonce[12] + ciphertext + tag[16]) şeklindedir — decryptAES ile eşleştirin; diğer dillerle birlikte çalışırken bu biçimi kendiniz açmanız gerekir.

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​

Kimlik doğrulama akışı script'leri için JWT oluşturma, ayrıştırma ve imza doğrulama (HMAC ailesi).

YöntemDöndürür
$jwt.sign(payload, secret, algorithm?)JWT dizesi; varsayılan HS256.
$jwt.decode(token){header, payload} nesnesi (imza doğrulanmaz); bozuk token'larda null döndürür.
$jwt.verify(token, secret, algorithm?)boolean — imza doğrulama sonucu.

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 — Veri Biçimlendirme​

Günlükleme ve hata ayıklama için JSON/XML güzel yazdırma ve küçültme. JSON anahtarları çıktıda alfabetik olarak sıralanır.

YöntemDöndürür
$format.json(str, indent?)Güzel yazdırılmış JSON; girinti 1–8 ile sınırlanır (varsayılan 2); geçersiz girişte "Error: Invalid JSON" döndürür.
$format.minify(str)Küçültülmüş JSON (sıralı anahtarlar, boşluksuz); geçersiz girişte "Error: Invalid JSON" döndürür.
$format.xml(str)Basit girintili 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 — Dosya Sistemi​

Script'ler içinde hafif dosya okuma/yazma (yapılandırma, önbellek, dışa aktarma). Yollar ~ genişletmeyi destekler; write eksik üst dizinleri otomatik oluşturur.

YöntemDöndürür
$fs.read(path)UTF-8 içerik; başarısızlıkta "Error: Cannot read file at <path>" döndürür.
$fs.readBinary(path)Base64 olarak baytlar; başarısızlıkta "" döndürür.
$fs.write(path, content)boolean — başarı.
$fs.exists(path)boolean.
$fs.delete(path)boolean; eksik dosyalar false döndürür.
$fs.list(path)Dizin girdilerinden string[]; başarısızlıkta [] döndürür.
$fs.info(path)JSON dizesi {size, modified, isDirectory, path}; eksik yollar undefined döndürür.
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
not

Başarısızlık biçimleri yöntem başına farklıdır: read bir "Error: ..." dizesi döndürür, readBinary "" döndürür, list [] döndürür ve info undefined döndürür — her birini buna göre ele alın.

$env — Ortam Değişkenleri​

Süreç ortam değişkenleri ve sistem yolları. Not: $env süreç ortamıdır (yürütmeler arasında paylaşılır, süreçle yaşar). Kullanıcıya yönelik değişkenleri kalıcı hale getirmek için bunun yerine sdk.setEnvVar veya SharedPreferences kullanın.

YöntemDöndürür
$env.get(key)Değer; eksik anahtarlar "" döndürür.
$env.set(key, value)boolean — setenv sonucu.
$env.all()Tüm ortam değişkenlerinin JSON dizesi.
$env.cwd()Geçerli çalışma dizini.
$env.tmpDir()Geçici dizin.
$env.homeDir()Kullanıcı ana dizini.
$env.set("APP_VERSION", "1.0.0");
$env.get("APP_VERSION"); // "1.0.0"
const all = JSON.parse($env.all());

$uuid — UUID​

UUID oluşturma ve doğrulama (istek kimlikleri, idempotency anahtarları).

YöntemDöndürür
$uuid.v4()Standart v4 UUID (büyük harfli, tireli), örn. "550e8400-E29B-41D4-A716-446655440000".
$uuid.compact()Tiresiz, küçük harfli biçim.
$uuid.validate(str)Dizenin geçerli bir UUID olup olmadığı.
const id = $uuid.v4();
$uuid.compact(); // "550e8400e29b41d4a716446655440000"
$uuid.validate($uuid.v4()); // true
$uuid.validate("not-uuid"); // false
not

validate yalnızca tireli biçimi kabul eder — validate($uuid.compact()) false döndürür. Kompakt bir dizeyi doğrulamadan önce tireleri yeniden ekleyin.

$log — Yapılandırılmış Günlükleme​

Zaman damgalı, seviyeli günlük satırları; motorun konsol sistemi üzerinden yönlendirilir (script'in log görünümüne toplanır).

YöntemDöndürür
$log.log(level, message, tag?)Biçimlendirilmiş günlük satırı (ayrıca yazdırılır).
$log.debug / info / warn / error(message)Kolaylık seviye yöntemleri, yalnızca çıktı.

Günlük satırı biçimi: [yyyy-MM-dd'T'HH:mm:ss.SSSZ] [LEVEL] [tag] message ([tag] bölümü, etiket verilmediğinde atlanır).

$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'leri​

fetch​

Script'lerden gerçek HTTP istekleri gönderin — Postman tarzı iş akışlarının ana kanalı.

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

options:

AlanTürVarsayılanAçıklama
methodstring"GET"Büyük/küçük harfe duyarsız; bilinmeyen değerler GET'e düşer.
timeoutIntervalnumber30Saniye cinsinden.
headers[[k, v]] veya [{k: v}][]Her iki biçim de kabul edilir.
textBodystring—İstek gövde metni.
encodingstring—"hex", textBody'nin bir hex dizesi olduğu anlamına gelir.

Çözülen değer düz bir nesnedir: statusCode (sayı), headers (tek anahtarlı nesnelerden oluşan dizi, yinelenen anahtarlar korunur) ve textBody() — otomatik karakter kümesi algılamasıyla {text, encoding} döndüren bir fonksiyon (çözülemeyen gövdeler {text: <hex>, encoding: "hex"} değerine düşer). Reddedilen değer bir hata mesajı dizesidir.

// 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 sınıfı, herhangi bir script'ten HTTP istekleri gönderir (fetch üzerine uygulanmıştır). Tüm yöntemler async'tir ve statusCode, headers ve textBody() içeren bir yanıt nesnesi döndürür.

YöntemAçıklama
HTTPClient.get(url, params?)Bir GET isteği gönderin.
HTTPClient.post(url, params?)Bir POST isteği gönderin.
HTTPClient.put(url, params?)Bir PUT isteği gönderin.
HTTPClient.update(url, params?)Bir UPDATE isteği gönderin.
HTTPClient.delete(url, params?)Bir DELETE isteği gönderin.
HTTPClient.request(url, method, params?)Özel bir yöntemle istek gönderin.

params, şu alanları içeren isteğe bağlı bir nesnedir:

  • headers: istek başlıkları nesnesi, örn. {"key1": "value1"}
  • body: istek gövdesi — bir dize, JSON nesnesi (otomatik serileştirilir) veya URLSearchParams
  • timeoutInterval: saniye cinsinden zaman aşımı (varsayılan 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);
}

Zamanlayıcılar​

setTimeout / setInterval / clearTimeout / clearInterval, tarayıcılarda olduğu gibi çalışır. Geri çağrılar seri bir motor kuyruğunda dağıtılır, böylece zamanlayıcılar ana iş parçacığından bağımsız olarak güvenilir şekilde tetiklenir.

FonksiyonDöndürür
setTimeout(callback, ms)Zamanlayıcı kimliği (dize), bir kez tetiklenir.
setInterval(callback, ms)Zamanlayıcı kimliği, tekrar tekrar tetiklenir.
clearTimeout(id) / clearInterval(id)İptal (idempotent, bilinmeyen kimlikler yok sayılır).
await new Promise(resolve => setTimeout(resolve, 500)); // wait 0.5s
const timer = setInterval(() => console.log("tick"), 1000);
setTimeout(() => clearInterval(timer), 3500);

Global Fonksiyonlar​

AdİmzaAçıklama
btoa(str)(string) → stringBase64 kodlama — UTF-8 simetrik semantiği (tarayıcıların aksine Latin1 dışı dizelere izin verilir).
atob(str)(string) → stringBase64 çözme; geçersiz girişte "" döndürür.
performance.now()() → numberEpoch'tan bu yana geçen milisaniyeler (sayfa yüklemesi değil).
sleep(ms)(number) → Promisems sonrasında çözülür; await sleep(1000) kullanın.
require(id)(string) → anyCommonJS semantiğiyle (module.exports) bir script kütüphanesi yükler; anahtar @libs/<key> şeklindedir ve script-kütüphanesi tanımlayıcısı → script-kütüphanesi adı (benzersiz) → yerleşik kütüphaneler sırasıyla çözülür; bulunamadığında fırlatır.
TextEncodernew TextEncoder().encode(str)UTF-8 kodlama, bir Uint8Array içine (encoding her zaman "utf-8").
crypto.getRandomValues(n)(Array) → number[]n adet rastgele UInt32 değeriyle doldurur.
crypto.randomUUID()() → stringRastgele UUID (büyük harfli, tireli).
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]

Kütüphaneler script modül yöneticisinde yönetilir. Require anahtarı her zaman @libs/<key> şeklindedir: script kütüphaneleriniz önce tanımlayıcıyla (yeniden adlandırmalarda kararlı), sonra adla (benzersiz eşleşme), sonra yerleşik kütüphaneler @libs/base64 / @libs/hex ile çözülür. Kütüphaneler module.exports ile dışa aktarır, diğer kütüphaneleri require edebilir ve eksik anahtar fırlatır (gönderim öncesi başarısızlıklar isteği iptal eder, yanıt sonrası başarısızlıklar orijinal yanıtı korur). Tam kılavuz için Quick Request scripting, Script Kütüphanelerini Require() ile Yükleme sayfasına bakın.

console​

console.log / info / warn / error, değerleri script'in log görünümüne yazdırır. Birden çok bağımsız değişken serileştirilir, böylece nesneleri ve dizileri doğrudan günlüğe kaydedebilirsiniz:

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

$log, yapılandırılmış, seviyeli çıktı sunar (bkz. $log) — her iki kanal da Hodor'un script log görünümünde görünür.

HTTP Sınıfları​

Request​

Request sınıfı, onRequest / onSessionCompleted fonksiyonlarına iletilen paketlenmiş HTTP isteğidir.

ÜyeTürAçıklama
schemestring (get / set)İsteğin şeması, örn. https.
hoststring (get / set)İsteğin ana bilgisayarı.
portnumber (get / set)İsteğin bağlantı noktası.
pathstring (get / set)İsteğin yolu.
methodstring (get / set)HTTP yöntemi, örn. GET.
queriesURLSearchParams (get)İsteğin sorgu parametreleri.
headersHeaders (get)İsteğin başlıkları.
bodyBody (get) / string | Map | Array | URLSearchParams (set)İsteğin gövdesi.
not

Başlıklar .set() / .append() ile değiştirilmelidir — indeks ataması (örn. headers["X-Key"] = v) yok sayılır.

Bir isteği kendiniz de oluşturabilirsiniz:

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 sınıfı, onResponse / onSessionCompleted fonksiyonlarına iletilen HTTP yanıtını temsil eder.

ÜyeTürAçıklama
statusCodenumber (get / set)Yanıtın durum kodu.
statusPhrasestring (get / set)Yanıtın durum ifadesi, örn. OK.
headersHeaders (get)Yanıtın başlıkları.
bodyBody (get) / string | Map | Array | URLSearchParams (set)Yanıtın gövdesi.
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 sınıfı bir HTTP isteğinin veya yanıtının gövdesini temsil eder. request.body / response.body değerine yeni bir değer atamak gövdenin tamamını değiştirir.

YöntemDöndürürAçıklama
parseText()string | nullGövdeyi metin olarak ayrıştırın.
parseJSON()object | nullGövdeyi JSON olarak ayrıştırın.
parseURLSearchParams()URLSearchParams | nullGövdeyi URL kodlu parametreler olarak ayrıştırın.
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 sınıfı HTTP başlıklarını temsil eder.

YöntemDöndürürAçıklama
append(name, value)voidBelirtilen başlığa bir değer ekleyin.
set(name, value)voidBelirtilen başlığın değerini ayarlayın (üzerine yazın).
get(name)string | nullBelirtilen başlığın değerini alın.
has(name)booleanBelirtilen başlığın var olup olmadığını kontrol edin.
delete(name)voidBelirtilen başlığı silin.
forEach(callback, thisArg?)voidHer başlık için bir fonksiyon çağırın.
entries() / keys() / values()IteratorGirdiler / anahtarlar / değerler üzerinde yineleme yapın.
encode()ArrayBaşlıkları serileştirilebilir bir biçime kodlayın.
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 sınıfı, URL sorgu (veya urlencoded gövde) parametrelerini temsil eder.

YöntemDöndürürAçıklama
append(name, value)voidBelirtilen parametreye bir değer ekleyin.
set(name, value)voidBelirtilen parametrenin değerini ayarlayın (üzerine yazın).
get(name)string | nullBelirtilen parametrenin değerini alın.
has(name)booleanBelirtilen parametrenin var olup olmadığını kontrol edin.
delete(name)voidBelirtilen parametreyi silin.
forEach(callback, thisArg?)voidHer parametre için bir fonksiyon çağırın.
entries() / keys() / values()IteratorGirdiler / anahtarlar / değerler üzerinde yineleme yapın.
sort()voidParametreleri sıralayın.
toString()stringBir urlencoded dizesine serileştirin.
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 sınıfı, script çalıştırmalarını ve uygulama yeniden başlatmalarını atlatan yerel kalıcı anahtar-değer depolaması sağlar (sistem kullanıcı varsayılanlarıyla desteklenir).

YöntemDöndürürAçıklama
SharedPreferences.write(key, value)voidBir değer yazın (string / number / boolean / object / array). null yazmak anahtarı siler.
SharedPreferences.read(key)anyAnahtarla ilişkili değeri okuyun, yoksa null döndürün.
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 Script'leri​

sdk (takma adı pm) yalnızca Quick Request gönderim öncesi/sonrası script'lerinde enjekte edilir. Uygulamanın değişken depolamasını (ortamlar, global ve çalışma zamanı değişkenleri) köprüler, assertion'ları toplar ve Postman benzeri bir API şekline sahiptir.

ÜyeAçıklama
sdk.env.get(key)Uygulamada tanımlanan bir ortam değişkenini okuyun.
sdk.env.set(key, value)Bir ortam değişkeni ayarlayın (sdk.setEnvVar ile aynı).
sdk.setEnvVar(key, value)Bir ortam değişkeni yazın — toplanır ve uygulamaya geri kalıcı hale getirilir.
sdk.setVar(key, value)Bir çalışma zamanı (yerel) değişkeni yazın.
sdk.setGlobalVar(key, value)Bir global değişken yazın.
sdk.getVar(key)Bir çalışma zamanı değişkenini okuyun.
sdk.test(name, fn)Adlandırılmış bir assertion bloğu çalıştırın; başarısızlıklar toplanır ve uygulamada raporlanır.
sdk.expect(value)Assertion ilkelleri: toBe, toEqual, toBeTruthy.
sdk.jsonPath(object, path)Nokta yolu araması, örn. "$.data.list[0].id".
sdk.utils.uuid()crypto.randomUUID() ile aynı.
sdk.utils.base64Encode(s) / base64Decode(s)btoa / atob ile aynı.
sdk.utils.md5(s)$hash.md5 ile aynı.
// 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;
}
not

Assertion sonuçları, gönderim öncesi script'ler için raporlanır. Yanıt sonrası script'lerde assertion'lar çalışır ancak sonuçlar toplanmaz.

Bağlamlar​

RewriteContext​

Rewrite script'lerine (onRequest / onResponse) iletilen bağlam nesnesi.

ÜyeTürAçıklama
isEnableOnRequestboolean (get)onRequest girişinin etkin olup olmadığı.
isEnableOnResponseboolean (get)onResponse girişinin etkin olup olmadığı.
parametersobject (get / set)onRequest ve onResponse arasında paylaşılan bir parametre sözlüğü.
scriptNamestring (get)Script'in adı.

CompletedContext​

HTTP completed script'lerine iletilen bağlam nesnesi.

ÜyeTürAçıklama
sessionobject (get)Completed script ile ilişkili oturum nesnesi.
scriptNamestring (get)Completed script'in adı.

ScheduleContext​

Schedule script'lerine iletilen bağlam nesnesi.

ÜyeTürAçıklama
parametersobject (get / set)Ayarlandığında bir sonraki çalışma döngüsüne iletilen parametreler.
cronstring (get)Zamanlamanın cron ifadesi.
repeatedCountnumber (get)Script'in kaç kez tekrarlandığı.
scriptNamestring (get)Zamanlanmış script'in adı.

Davranış Notları​

  • Yakalanmayan istisnalar script'i başarısız kılar. Hatalar (abort() kaynaklı AbortError dahil) Hodor'a yayılır ve yürütme başarısız olarak raporlanır — hatadan önce yapılan kısmi yeniden yazımlar atılır, bu yüzden riskli blokları try / catch ile koruyun.
  • Zaman aşımı gözcüsü. Her script çalıştırmasının bir zaman bütçesi vardır; hiç bitmeyen bir script (örn. sonsuz döngü ya da takılı kalan bir await) zorla kesilir ve zaman aşımı olarak raporlanır.
  • Dönüş değeri olarak hatalar. Bazı API'ler asla fırlatmaz: $codec.base64Decode "" döndürür, $crypto "Error: ..." dizeleri döndürür, $fs.read "Error: ..." dizeleri döndürür ve $fs.info undefined döndürür. try / catch'e güvenmek yerine bu dönüş değerlerini kontrol edin.
  • console.log vs $log. İkisi de script log görünümünde görünür; $log zaman damgaları ve seviyeler ekler.
  • Script çalışma zamanı kalıcılığı. sdk.setVar ile yazılan değişkenler ve $fs ile yazılan dosyalar, aynı script'in sonraki yürütmeleri için kullanılabilir kalır; SharedPreferences uygulama yeniden başlatmalarında kalıcıdır.