browser.userScripts

ब्यौरा

User Scripts के कॉन्टेक्स्ट में उपयोगकर्ता की स्क्रिप्ट को लागू करने के लिए, userScripts API का इस्तेमाल करें.

अनुमतियां

userScripts

User Scripts API का इस्तेमाल करने के लिए, browser.userScripts, अपने मेनिफ़ेस्ट.json में "userScripts" अनुमति जोड़ें. साथ ही, "host_permissions" उन साइटों के लिए अनुमति जोड़ें जिन पर आपको स्क्रिप्ट चलानी हैं.

{
  "name": "User script test extension",
  "manifest_version": 3,
  "minimum_chrome_version": "120",
  "permissions": [
    "userScripts"
  ],
  "host_permissions": [
    "*://example.com/*"
  ]
}

उपलब्धता

Chrome 120 या इसके बाद के वर्शन MV3 या इसके बाद के वर्शन

कॉन्सेप्ट और इस्तेमाल करने का तरीका

उपयोगकर्ता स्क्रिप्ट, कोड का एक स्निपेट होता है. इसे वेब पेज में इसलिए डाला जाता है, ताकि उसकी बनावट या व्यवहार में बदलाव किया जा सके. एक्सटेंशन की अन्य सुविधाओं, जैसे कि कॉन्टेंट स्क्रिप्ट और browser.scripting एपीआई के उलट, User Scripts API की मदद से कोई भी कोड चलाया जा सकता है. यह एपीआई उन एक्सटेंशन के लिए ज़रूरी है जो उपयोगकर्ता की ओर से दी गई स्क्रिप्ट चलाते हैं. इन स्क्रिप्ट को आपके एक्सटेंशन पैकेज के हिस्से के तौर पर शिप नहीं किया जा सकता.

userScripts API के इस्तेमाल की सुविधा चालू करना

आपके एक्सटेंशन को userScripts API का इस्तेमाल करने की अनुमति मिलने के बाद, उपयोगकर्ताओं को एक खास टॉगल चालू करना होगा. इससे आपका एक्सटेंशन, एपीआई का इस्तेमाल कर पाएगा. ज़रूरी टॉगल और बंद होने पर एपीआई का व्यवहार, Chrome के वर्शन के हिसाब से अलग-अलग होता है.

यहां दी गई जांच का इस्तेमाल करके यह पता लगाएं कि उपयोगकर्ता को कौनसी टॉगल सेटिंग चालू करनी है. उदाहरण के लिए, नए उपयोगकर्ता के ऑनबोर्डिंग के दौरान:

let version = Number(navigator.userAgent.match(/(Chrome|Chromium)\/([0-9]+)/)?.[2]);
if (version >= 138) {
  // Allow User Scripts toggle will be used.
} else {
  // Developer mode toggle will be used.
}

यहां दिए गए सेक्शन में, अलग-अलग टॉगल और उन्हें चालू करने के तरीके के बारे में बताया गया है.

Chrome के 138 से पहले के वर्शन (डेवलपर मोड टॉगल)

एक्सटेंशन डेवलपर के तौर पर, आपने Chrome में डेवलपर मोड पहले से चालू किया हुआ है. आपके उपयोगकर्ताओं को भी डेवलपर मोड चालू करना होगा.

अपने उपयोगकर्ताओं के लिए, एक्सटेंशन के दस्तावेज़ में यहां दिए गए निर्देशों को कॉपी करके चिपकाया जा सकता है

  1. नए टैब में chrome://extensions डालकर, एक्सटेंशन पेज पर जाएं. (chrome:// यूआरएल को लिंक नहीं किया जा सकता.)

  2. डेवलपर मोड के बगल में मौजूद टॉगल स्विच पर क्लिक करके, डेवलपर मोड चालू करें.

    Chrome एक्सटेंशन पेज पर, डेवलपर मोड टॉगल को हाइलाइट किया गया है

    एक्सटेंशन पेज (chrome://extensions)

Chrome के 138 और इसके बाद के वर्शन (यूज़र स्क्रिप्ट को चालू करने की अनुमति दें टॉगल)

उपयोगकर्ता स्क्रिप्ट की अनुमति दें टॉगल, हर एक्सटेंशन के ज़्यादा जानकारी वाले पेज पर होता है. उदाहरण के लिए, chrome://extensions/?id=YOUR_EXTENSION_ID.

अपने उपयोगकर्ताओं के लिए, एक्सटेंशन के दस्तावेज़ में यहां दिए गए निर्देशों को कॉपी करके चिपकाया जा सकता है:

  1. नए टैब में chrome://extensions डालकर, एक्सटेंशन पेज पर जाएं. (chrome:// यूआरएल को लिंक नहीं किया जा सकता.)
  2. एक्सटेंशन के बारे में ज़्यादा जानकारी देखने के लिए, एक्सटेंशन कार्ड पर मौजूद "जानकारी" बटन पर क्लिक करें.
  3. उपयोगकर्ता स्क्रिप्ट की अनुमति दें के बगल में मौजूद टॉगल स्विच पर क्लिक करें.
एक्सटेंशन के ज़्यादा जानकारी वाले पेज पर, 'यूज़र स्क्रिप्ट को चालू करें' टॉगल
यूज़र स्क्रिप्ट को चालू करने का टॉगल (chrome://extensions/?id=abc...)

देखें कि एपीआई उपलब्ध है या नहीं

हमारा सुझाव है कि आप यहां दिया गया तरीका अपनाकर यह जांच करें कि userScripts API चालू है या नहीं. यह तरीका Chrome के सभी वर्शन में काम करता है. यह जांच, browser.userScripts() तरीके को कॉल करने की कोशिश करती है. एपीआई उपलब्ध होने पर, यह तरीका हमेशा काम करता है. अगर इस कॉल से कोई गड़बड़ी होती है, तो इसका मतलब है कि एपीआई उपलब्ध नहीं है:

function isUserScriptsAvailable() {
  try {
    // Method call which throws if API permission or toggle is not enabled.
    browser.userScripts.getScripts();
    return true;
  } catch {
    // Not available.
    return false;
  }
}

आइसोलेटेड वर्ल्ड में काम करना

उपयोगकर्ता और कॉन्टेंट स्क्रिप्ट, दोनों को आइसोलेटेड वर्ल्ड या मेन वर्ल्ड में चलाया जा सकता है. आइसोलेटेड वर्ल्ड, एक ऐसा एक्ज़ीक्यूशन एनवायरमेंट होता है जिसे होस्ट पेज या अन्य एक्सटेंशन ऐक्सेस नहीं कर सकते. इससे उपयोगकर्ता स्क्रिप्ट, होस्ट पेज या अन्य एक्सटेंशन की उपयोगकर्ता और कॉन्टेंट स्क्रिप्ट पर असर डाले बिना, अपने JavaScript एनवायरमेंट को बदल सकती है. इसके उलट, उपयोगकर्ता की स्क्रिप्ट (और कॉन्टेंट स्क्रिप्ट) होस्ट पेज, उपयोगकर्ता, और अन्य एक्सटेंशन की कॉन्टेंट स्क्रिप्ट को नहीं दिखती हैं. मुख्य दुनिया में चलने वाली स्क्रिप्ट को होस्ट पेज और अन्य एक्सटेंशन ऐक्सेस कर सकते हैं. साथ ही, ये स्क्रिप्ट होस्ट पेज और अन्य एक्सटेंशन को दिखती हैं. दुनिया को चुनने के लिए, userScripts.register() को कॉल करते समय "USER_SCRIPT" या "MAIN" पास करें.

USER_SCRIPT दुनिया के लिए कॉन्टेंट की सुरक्षा के लिए बनी नीति को कॉन्फ़िगर करने के लिए, userScripts.configureWorld() को कॉल करें:

browser.userScripts.configureWorld({
  csp: "script-src 'self'"
});

मैसेज सेवा

कॉन्टेंट स्क्रिप्ट और ऑफ़स्क्रीन दस्तावेज़ों की तरह, उपयोगकर्ता स्क्रिप्ट भी एक्सटेंशन के अन्य हिस्सों से कम्यूनिकेट करती हैं. इसके लिए, मैसेजिंग का इस्तेमाल किया जाता है. इसका मतलब है कि वे runtime.sendMessage() और runtime.connect() को कॉल कर सकती हैं, जैसे कि एक्सटेंशन का कोई अन्य हिस्सा करता है. हालांकि, इन्हें इवेंट हैंडलर का इस्तेमाल करके रिसीव किया जाता है. इसका मतलब है कि ये onMessage या onConnect का इस्तेमाल नहीं करते. इन हैंडलर को runtime.onUserScriptMessage और runtime.onUserScriptConnect कहा जाता है. डेडिकेटेड हैंडलर की मदद से, उपयोगकर्ता स्क्रिप्ट से मिले मैसेज की पहचान करना आसान हो जाता है. ये स्क्रिप्ट, कम भरोसेमंद कॉन्टेक्स्ट होती हैं.

मैसेज भेजने से पहले, आपको configureWorld() को कॉल करना होगा. साथ ही, messaging आर्ग्युमेंट को true पर सेट करना होगा. ध्यान दें कि csp और messaging, दोनों तर्कों को एक साथ पास किया जा सकता है.

browser.userScripts.configureWorld({
  messaging: true
});

एक्सटेंशन से जुड़े अपडेट

एक्सटेंशन अपडेट होने पर, उपयोगकर्ता की स्क्रिप्ट मिट जाती हैं. एक्सटेंशन के सर्विस वर्कर में, runtime.onInstalled इवेंट हैंडलर में कोड चलाकर, उन्हें वापस जोड़ा जा सकता है. सिर्फ़ उस "update" वजह के बारे में जानकारी दें जिसे इवेंट के कॉलबैक में पास किया गया है.

उदाहरण

यह उदाहरण, हमारी सैंपल रिपॉज़िटरी में मौजूद userScript के सैंपल से लिया गया है.

स्क्रिप्ट रजिस्टर करना

यहां दिए गए उदाहरण में, register() को कॉल करने का बुनियादी तरीका दिखाया गया है. पहला आर्ग्युमेंट, रजिस्टर की जाने वाली स्क्रिप्ट को तय करने वाले ऑब्जेक्ट का ऐरे होता है. यहां दिखाए गए विकल्पों के अलावा, और भी विकल्प मौजूद हैं.

browser.userScripts.register([{
  id: 'test',
  matches: ['*://*/*'],
  js: [{code: 'alert("Hi!")'}]
}]);

टाइप

ExecutionWorld

यह JavaScript का वह एनवायरमेंट होता है जिसमें उपयोगकर्ता की स्क्रिप्ट काम करती है.

Enum

"MAIN"
यह DOM के एक्ज़ीक्यूशन एनवायरमेंट के बारे में बताता है. यह एक्ज़ीक्यूशन एनवायरमेंट, होस्ट पेज के JavaScript के साथ शेयर किया जाता है.

"USER_SCRIPT"
यह उपयोगकर्ता की स्क्रिप्ट के लिए, खास तौर पर तैयार किए गए एक्ज़ीक्यूशन एनवायरमेंट के बारे में बताता है. साथ ही, यह पेज के सीएसपी से बाहर होता है.

InjectionResult

Chrome 135 या इसके बाद के वर्शन

प्रॉपर्टी

  • documentId

    स्ट्रिंग

    इंजेक्शन से जुड़ा दस्तावेज़.

  • गड़बड़ी

    string ज़रूरी नहीं है

    अगर कोई गड़बड़ी हुई है, तो उसकी जानकारी. error और result एक-दूसरे से अलग होते हैं.

  • frameId

    संख्या

    इंजेक्शन से जुड़ा फ़्रेम.

  • नतीजा

    कोई भी ज़रूरी नहीं है

    स्क्रिप्ट को चलाने का नतीजा.

InjectionTarget

Chrome 135 या इसके बाद के वर्शन

प्रॉपर्टी

  • allFrames

    बूलियन ज़रूरी नहीं है

    स्क्रिप्ट को टैब में मौजूद सभी फ़्रेम में इंजेक्ट करना चाहिए या नहीं. डिफ़ॉल्ट रूप से, यह 'गलत' पर सेट होती है. अगर frameIds एट्रिब्यूट की वैल्यू दी गई है, तो यह शर्त पूरी नहीं होनी चाहिए.

  • documentIds

    string[] ज़रूरी नहीं है

    उन documentId के आईडी जिनमें डेटा डालना है. अगर frameIds सेट है, तो इसे सेट नहीं किया जाना चाहिए.

  • frameIds

    number[] ज़रूरी नहीं

    उन फ़्रेम के आईडी जिनमें स्क्रिप्ट को इंजेक्ट करना है.

  • tabId

    संख्या

    उस टैब का आईडी जिसमें कोड डालना है.

RegisteredUserScript

प्रॉपर्टी

  • allFrames

    बूलियन ज़रूरी नहीं है

    अगर यह वैल्यू सही है, तो इसे सभी फ़्रेम में डाला जाएगा. भले ही, फ़्रेम टैब में सबसे ऊपर वाला फ़्रेम न हो. यूआरएल से जुड़ी ज़रूरी शर्तों के लिए, हर फ़्रेम की अलग से जांच की जाती है. अगर यूआरएल से जुड़ी ज़रूरी शर्तें पूरी नहीं होती हैं, तो यह चाइल्ड फ़्रेम में नहीं डाला जाएगा. इसकी डिफ़ॉल्ट वैल्यू false होती है. इसका मतलब है कि सिर्फ़ सबसे ऊपर वाले फ़्रेम को मैच किया जाता है.

  • excludeGlobs

    string[] ज़रूरी नहीं है

    यह उन पेजों के लिए वाइल्डकार्ड पैटर्न तय करता है जिनमें इस उपयोगकर्ता स्क्रिप्ट को इंजेक्ट नहीं किया जाएगा.

  • excludeMatches

    string[] ज़रूरी नहीं है

    उन पेजों को बाहर रखता है जिनमें इस उपयोगकर्ता स्क्रिप्ट को शामिल किया जाता है. इन स्ट्रिंग के सिंटैक्स के बारे में ज़्यादा जानकारी के लिए, मैच पैटर्न देखें.

  • आईडी

    स्ट्रिंग

    एपीआई कॉल में बताई गई उपयोगकर्ता स्क्रिप्ट का आईडी. यह प्रॉपर्टी '_' से शुरू नहीं होनी चाहिए, क्योंकि इसे जनरेट किए गए स्क्रिप्ट आईडी के लिए प्रीफ़िक्स के तौर पर रिज़र्व किया गया है.

  • includeGlobs

    string[] ज़रूरी नहीं है

    इससे उन पेजों के लिए वाइल्डकार्ड पैटर्न तय किए जाते हैं जिनमें इस उपयोगकर्ता स्क्रिप्ट को इंजेक्ट किया जाएगा.

  • js

    ScriptSource[] ज़रूरी नहीं है

    ScriptSource ऑब्जेक्ट की सूची. ये ऑब्जेक्ट, उन स्क्रिप्ट के सोर्स तय करते हैं जिन्हें मिलते-जुलते पेजों में इंजेक्ट किया जाना है. ${ref:register} के लिए इस प्रॉपर्टी की वैल्यू सबमिट करना ज़रूरी है. साथ ही, इसकी वैल्यू सबमिट करने पर, यह एक ऐसा कलेक्शन होना चाहिए जिसमें कम से कम एक आइटम मौजूद हो.

  • मैच

    string[] ज़रूरी नहीं है

    इससे पता चलता है कि इस उपयोगकर्ता स्क्रिप्ट को किन पेजों में डाला जाएगा. इन स्ट्रिंग के सिंटैक्स के बारे में ज़्यादा जानकारी के लिए, मैच पैटर्न देखें. ${ref:register} के लिए इस प्रॉपर्टी की वैल्यू सबमिट करना ज़रूरी है.

  • runAt

    RunAt optional

    इससे यह तय होता है कि JavaScript फ़ाइलों को वेब पेज में कब इंजेक्ट किया जाता है. डिफ़ॉल्ट वैल्यू और सुझाई गई वैल्यू document_idle है.

  • दुनिया

    ExecutionWorld ज़रूरी नहीं है

    स्क्रिप्ट को चलाने के लिए JavaScript एक्ज़ीक्यूशन एनवायरमेंट. डिफ़ॉल्ट वैल्यू `USER_SCRIPT` है.

  • worldId

    string ज़रूरी नहीं है

    Chrome 133 या इसके बाद का वर्शन

    यह कुकी, उपयोगकर्ता की स्क्रिप्ट का वह वर्ल्ड आईडी तय करती है जिसमें स्क्रिप्ट को एक्ज़ीक्यूट करना है. अगर इसे शामिल नहीं किया जाता है, तो स्क्रिप्ट डिफ़ॉल्ट उपयोगकर्ता स्क्रिप्ट वर्ल्ड में एक्ज़ीक्यूट होगी. यह सिर्फ़ तब मान्य होता है, जब world को शामिल न किया गया हो या USER_SCRIPT के तौर पर शामिल किया गया हो. शुरुआत में अंडरस्कोर (_) वाली वैल्यू रिज़र्व होती हैं.

ScriptSource

प्रॉपर्टी

  • कोड

    string ज़रूरी नहीं है

    यह एक स्ट्रिंग होती है, जिसमें इंजेक्ट करने के लिए JavaScript कोड होता है. file या code में से किसी एक की जानकारी देना ज़रूरी है.

  • फ़ाइल

    string ज़रूरी नहीं है

    एक्सटेंशन की रूट डायरेक्ट्री के हिसाब से, इंजेक्ट की जाने वाली JavaScript फ़ाइल का पाथ. file या code में से किसी एक की जानकारी देना ज़रूरी है.

UserScriptFilter

प्रॉपर्टी

  • आईडी

    string[] ज़रूरी नहीं है

    getScripts सिर्फ़ उन स्क्रिप्ट को दिखाता है जिनके आईडी इस सूची में दिए गए हैं.

UserScriptInjection

Chrome 135 या इसके बाद के वर्शन

प्रॉपर्टी

  • injectImmediately

    बूलियन ज़रूरी नहीं है

    क्या टारगेट में इंजेक्शन को जल्द से जल्द ट्रिगर किया जाना चाहिए. ध्यान दें कि इससे इस बात की गारंटी नहीं मिलती कि पेज लोड होने से पहले ही स्क्रिप्ट इंजेक्ट हो जाएगी. ऐसा इसलिए, क्योंकि हो सकता है कि स्क्रिप्ट के टारगेट तक पहुंचने से पहले ही पेज लोड हो गया हो.

  • ScriptSource ऑब्जेक्ट की सूची. ये ऑब्जेक्ट, टारगेट में इंजेक्ट की जाने वाली स्क्रिप्ट के सोर्स तय करते हैं.

  • टारगेट

    InjectionTarget

    वह जानकारी जिससे यह पता चलता है कि स्क्रिप्ट को किस टारगेट में इंजेक्ट करना है.

  • दुनिया

    ExecutionWorld ज़रूरी नहीं है

    वह JavaScript "world" जिसमें स्क्रिप्ट को चलाना है. डिफ़ॉल्ट वैल्यू USER_SCRIPT है.

  • worldId

    string ज़रूरी नहीं है

    यह कुकी, उपयोगकर्ता की स्क्रिप्ट का वह वर्ल्ड आईडी तय करती है जिसमें स्क्रिप्ट को एक्ज़ीक्यूट करना है. अगर इसे शामिल नहीं किया जाता है, तो स्क्रिप्ट डिफ़ॉल्ट उपयोगकर्ता स्क्रिप्ट वर्ल्ड में एक्ज़ीक्यूट होगी. यह सिर्फ़ तब मान्य होता है, जब world को शामिल न किया गया हो या USER_SCRIPT के तौर पर शामिल किया गया हो. शुरुआत में अंडरस्कोर (_) वाली वैल्यू रिज़र्व होती हैं.

WorldProperties

प्रॉपर्टी

  • csp

    string ज़रूरी नहीं है

    इससे दुनिया के सीएसएपी के बारे में पता चलता है. डिफ़ॉल्ट रूप से, यह `ISOLATED` world csp पर सेट होता है.

  • मैसेज सेवा

    बूलियन ज़रूरी नहीं है

    इससे यह पता चलता है कि Messaging API उपलब्ध हैं या नहीं. डिफ़ॉल्ट वैल्यू false है.

  • worldId

    string ज़रूरी नहीं है

    Chrome 133 या इसके बाद का वर्शन

    यह अपडेट करने के लिए, उपयोगकर्ता की स्क्रिप्ट के खास वर्ल्ड का आईडी तय करता है. अगर यह विकल्प नहीं दिया जाता है, तो यह डिफ़ॉल्ट उपयोगकर्ता स्क्रिप्ट वर्ल्ड की प्रॉपर्टी अपडेट करता है. शुरुआत में अंडरस्कोर (_) वाली वैल्यू रिज़र्व होती हैं.

तरीके

configureWorld()

chrome.userScripts.configureWorld(
  properties: WorldProperties,
): Promise<void>

यह नीति, `USER_SCRIPT` के एक्ज़ीक्यूशन एनवायरमेंट को कॉन्फ़िगर करती है.

पैरामीटर

  • प्रॉपर्टी

    WorldProperties

    इसमें उपयोगकर्ता की स्क्रिप्ट के वर्ल्ड कॉन्फ़िगरेशन की जानकारी होती है.

रिटर्न

  • Promise<void>

    यह प्रॉमिस तब रिज़ॉल्व होता है, जब दुनिया को कॉन्फ़िगर कर दिया जाता है.

execute()

Chrome 135 या इसके बाद के वर्शन 
chrome.userScripts.execute(
  injection: UserScriptInjection,
): Promise<InjectionResult[]>

यह स्क्रिप्ट को टारगेट कॉन्टेक्स्ट में इंजेक्ट करता है. डिफ़ॉल्ट रूप से, स्क्रिप्ट document_idle पर चलेगी. अगर पेज पहले ही लोड हो चुका है, तो स्क्रिप्ट तुरंत चलेगी. अगर injectImmediately प्रॉपर्टी सेट की गई है, तो स्क्रिप्ट तुरंत इंजेक्ट हो जाएगी. भले ही, पेज पूरी तरह से लोड न हुआ हो. अगर स्क्रिप्ट से कोई प्रॉमिस मिलता है, तो ब्राउज़र प्रॉमिस के पूरा होने का इंतज़ार करेगा और नतीजे के तौर पर मिली वैल्यू दिखाएगा.

पैरामीटर

रिटर्न

getScripts()

chrome.userScripts.getScripts(
  filter?: UserScriptFilter,
): Promise<RegisteredUserScript[]>

यह फ़ंक्शन, इस एक्सटेंशन के लिए डाइनैमिक तरीके से रजिस्टर की गई सभी उपयोगकर्ता स्क्रिप्ट दिखाता है.

पैरामीटर

  • फ़िल्टर

    UserScriptFilter ज़रूरी नहीं है

    अगर यह तरीका तय किया गया है, तो यह सिर्फ़ उन उपयोगकर्ता स्क्रिप्ट को दिखाता है जो इससे मेल खाती हैं.

रिटर्न

  • यह प्रॉमिस, रजिस्टर की गई स्क्रिप्ट के साथ पूरा होता है. गड़बड़ी होने पर, प्रॉमिस अस्वीकार कर दिया जाएगा.

getWorldConfigurations()

Chrome 133 या इसके बाद का वर्शन 
chrome.userScripts.getWorldConfigurations(): Promise<WorldProperties[]>

यह फ़ंक्शन, रजिस्टर किए गए सभी वर्ल्ड कॉन्फ़िगरेशन को वापस लाता है.

रिटर्न

  • Promise<WorldProperties[]>

    यह प्रॉमिस, रजिस्टर किए गए दुनिया के कॉन्फ़िगरेशन के साथ पूरा होता है.

register()

chrome.userScripts.register(
  scripts: RegisteredUserScript[],
): Promise<void>

यह कुकी, इस एक्सटेंशन के लिए एक या उससे ज़्यादा उपयोगकर्ता स्क्रिप्ट रजिस्टर करती है.

पैरामीटर

  • स्क्रिप्ट

    RegisteredUserScript[]

    इसमें रजिस्टर की जाने वाली उपयोगकर्ता स्क्रिप्ट की सूची होती है.

रिटर्न

  • Promise<void>

    यह प्रॉमिस तब रिज़ॉल्व होता है, जब स्क्रिप्ट पूरी तरह से रजिस्टर हो जाती हैं. गड़बड़ी होने पर, प्रॉमिस अस्वीकार कर दिया जाएगा.

resetWorldConfiguration()

Chrome 133 या इसके बाद का वर्शन 
chrome.userScripts.resetWorldConfiguration(
  worldId?: string,
): Promise<void>

यह कुकी, उपयोगकर्ता की स्क्रिप्ट के लिए कॉन्फ़िगरेशन रीसेट करती है. इस आईडी के साथ दुनिया में इंजेक्ट की गई कोई भी स्क्रिप्ट, दुनिया के डिफ़ॉल्ट कॉन्फ़िगरेशन का इस्तेमाल करेगी.

पैरामीटर

  • worldId

    string ज़रूरी नहीं है

    रीसेट करने के लिए, उपयोगकर्ता स्क्रिप्ट वर्ल्ड का आईडी. अगर इसे शामिल नहीं किया जाता है, तो दुनिया के डिफ़ॉल्ट कॉन्फ़िगरेशन को रीसेट कर देता है.

रिटर्न

  • Promise<void>

    यह प्रॉमिस तब पूरा होता है, जब कॉन्फ़िगरेशन रीसेट हो जाता है.

unregister()

chrome.userScripts.unregister(
  filter?: UserScriptFilter,
): Promise<void>

यह एक्सटेंशन के लिए, डाइनैमिक तरीके से रजिस्टर की गई सभी उपयोगकर्ता स्क्रिप्ट को अनरजिस्टर करता है.

पैरामीटर

  • फ़िल्टर

    UserScriptFilter ज़रूरी नहीं है

    अगर इस तरीके के बारे में बताया गया है, तो यह सिर्फ़ उन उपयोगकर्ता स्क्रिप्ट को अनरजिस्टर करता है जो इससे मेल खाती हैं.

रिटर्न

  • Promise<void>

    यह एक प्रॉमिस है. स्क्रिप्ट के पूरी तरह से अनरजिस्टर होने के बाद, इसे रिज़ॉल्व कर दिया जाता है. गड़बड़ी होने पर, प्रॉमिस अस्वीकार कर दिया जाएगा.

update()

chrome.userScripts.update(
  scripts: RegisteredUserScript[],
): Promise<void>

यह एक्सटेंशन के लिए, एक या उससे ज़्यादा उपयोगकर्ता स्क्रिप्ट अपडेट करता है.

पैरामीटर

  • स्क्रिप्ट

    RegisteredUserScript[]

    इसमें अपडेट की जाने वाली उपयोगकर्ता स्क्रिप्ट की सूची होती है. किसी प्रॉपर्टी को सिर्फ़ तब अपडेट किया जाता है, जब उसे इस ऑब्जेक्ट में शामिल किया गया हो. अगर स्क्रिप्ट पार्स करने/फ़ाइल की पुष्टि करने के दौरान गड़बड़ियां होती हैं या दिए गए आईडी, पूरी तरह से रजिस्टर की गई स्क्रिप्ट से मेल नहीं खाते हैं, तो कोई भी स्क्रिप्ट अपडेट नहीं की जाती है.

रिटर्न

  • Promise<void>

    यह प्रॉमिस तब पूरा होता है, जब स्क्रिप्ट पूरी तरह से अपडेट हो जाती हैं. गड़बड़ी होने पर, प्रॉमिस अस्वीकार कर दिया जाएगा.