GM.getResourceText

From GreaseSpot Wiki
Revision as of 06:00, 12 December 2007 by Marti (talk | contribs) (→‎<code>resourceName</code>: Cleaned up mini-description)
Jump to navigationJump to search

Template:Underscore


Description

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

Examples | Notes

Syntax

GM_getResourceText( resourceName )

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

top

Properties


resourceName

Value: String
Usage: resourceName = "metadata-resource-name[1]";
  • 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.

top | back

Examples

// ==UserScript==
// @name           My Script
// @namespace      http://www.example.com/gmscripts/
// @description    Example GM_getResourceText
// @include        http://www.example.com/*
// @resource       prototype http://www.prototypejs.org/assets/2007/11/6/prototype.js
// ==/UserScript==

/* some code */

location.href = "javascript:void(" + GM_getResourceText("prototype") + ")"; 

top

Notes

[1] While the variable names here are non-semantic, it is assumed that it should be compatible with JavaScript variable naming conventions and XML/CSS naming conventions to help keep things consistent.

top