scope-provider v0.11.0

If links in this document aren't work correctly, try to open it from here

Name

Scope.Provider - cross-platform JavaScript scope provider

SYNOPSIS

    var provider = new Scope.Provider.IFrame()
    
    provider.setup(function () {
    
        if (provider.scope.SOME_GLOBAL == 'some_value') {
            ...
        }
        
        provider.runCode(text, callback)
        
        ...
        
        provider.runScript(url, callback)
        
        ...
        
        provider.cleanup()        
    })
    

INSTALLATION

From npm:

> [sudo] npm install scope-provider --unsafe-perm=true         

Tarballs are available for downloading at: http://search.npmjs.org/#/scope-provider

SETUP

In NodeJS:

require('scope-provider')

var provider = new Scope.Provider.NodeJS()

provider.setup(function () {
    ...
})

In browsers (assuming you've completed the 3.1 item from this document):

<script type="text/javascript" src="/jsan/Task/Scope/Provider/Core.js"></script>
<script type="text/javascript">

    var provider = new Scope.Provider.IFrame()
    
    provider.setup(function () {
        ...
    })
</script>

DESCRIPTION

Scope.Provider distribution implements cross-platform (browser/NodeJS) creation of the new JavaScript scope. By itself, Scope.Provider is an abstract class, all concrete work is delegated to its subclasses:

Scope.Provider.IFrame

Scope.Provider.Window

Scope.Provider.NodeJS

ATTRIBUTES

scope

Object scope

A newly created scope (usually window in browsers and global in NodeJS)

METHODS

setup

setup(Function callback)

Set up a new scope. Scope will be ready in the provided callback. Callback will receive an instance of Scope.Provider as the 1st argument

runCode

runCode(String text, Function callback)

Run a code, presented with text argument, in the previously created scope. Code will be ran by the time of the callback function called. Callback won't receive any arguments.

runScript

runScript(String url, Function callback)

Run a code, in script on the url, in the previously created scope. Code will be ran by the time of the callback function called. Callback won't receive any arguments.

cleanup

cleanup()

Releases any resources, used during scope creation.

GETTING HELP

This extension is supported via github issues tracker: http://github.com/SamuraiJack/Scope-Provider/issues

You can also ask questions at IRC channel : #joose

Or the mailing list: http://groups.google.com/group/joose-js

SEE ALSO

Web page of this module: http://github.com/SamuraiJack/Scope-Provider/

General documentation for Joose: http://joose.github.com/Joose

BUGS

All complex software has bugs lurking in it, and this module is no exception.

Please report any bugs through the web interface at http://github.com/SamuraiJack/Scope-Provider/issues

AUTHORS

Nickolay Platonov nplatonov@cpan.org

COPYRIGHT AND LICENSE

BSD 2-Clause License

Copyright (c) 2010-2016, Nickolay Platonov nplatonov@cpan.org. All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

• Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

• Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.