GM.getResourceText: Difference between revisions

From GreaseSpot Wiki
Jump to navigationJump to search
m (Text replace - "top | back'' " to "")
m (Text replace - "{{Samp |1=<pre style="border: none; margin: inherit;">" to "<pre class='sample'>")
Line 31: Line 31:


== Examples ==
== Examples ==
{{Samp |1=<pre style="border: none; margin: inherit;">
<pre class='sample'>
// ==UserScript==
// ==UserScript==
// @name          My Script
// @name          My Script

Revision as of 21:58, 3 February 2010


Description

This API method loads an external resource, such as an external JavaScript routine, and returns the string for use in the DOM.

Syntax

GM_getResourceText( resourceName )

Value: Function
Returns: String
Compatibility: Greasemonkey 0.8.0+
Parameters
Properties
resourceName

Properties


resourceName

Value: String
Usage: resourceName = "metadata_block_resourceName";
  • While the resourceName is non-semantic, it is suggested that it should be compatible with JavaScript variable naming conventions and XML/CSS naming conventions to help keep things consistent.
  • This value is used in retrieval of the same-named resource specified in the corresponding metadata block @resource key. After it is retrieved, no formatting on the resource will occur, and it will be returned upon completion of this API method.


Examples

// ==UserScript==
// @name          My Script
// @namespace     http://www.example.com/gmscripts/
// @description   Scripting is fun
// @include       http://www.example.com/*
// @resource      prototype http://www.example.com/prototype.js
// ==/UserScript==

(function() {
  // some code

  var myPrototype = GM_getResourceText("prototype");

  // some code
})();

}}