Code Monkey home page Code Monkey logo

lsn-javascript's Introduction

lsn-javascript

An pragmatic library which encourages namespaces, i.e. packages, and multiple inheritence

This implementation considers each package to be an instantiable component that is provided a pointer back to the library instance for which it is being created. The intentions are to:

  1. Provide management which enables one to division their code into logical packages and avoid clobbering global variables.

  2. Scope the window and document objects such that one may instantiate the library to act upon a child IFRAME, without changing its dependencies nor incurring the cost of additional HTTP requests to the library files.

  3. Namespaces, i.e., packages, may be extended at any time, and multiple times.

Packages may contain local private variables, classes, and functions. Namespaces are extendable, allowing the end product to avoid naming collisions.

A basic example

<!--
  Library scripts
  Usually the library files are compiled and minimized (see Compiling 
  below).  Here each is referenced individually for verbosity.
-->
<script src="src/lib/ecma/ECMAScript.js" type="text/javascript"></script>
<script src="src/lib/ecma/global.js" type="text/javascript"></script>
<script type="text/javascript">
  js.extend('local', function (js) {

    // The `this` pointer references the namespace we are extending.
    var Package = this;

    Package.alertHello = function () {
      alert('Hello');
    };

  });
</script>

<!--
  User scripts
-->
<script type="text/javascript">
  js.local.alertHello();
</script>

Compiling

See the specs/ directory for sample build files. The src/bin/lsn-jsc command is used to compile the scripts according to the build file.

The lsn-jsc utility requires lsn-data-hub be installed (or available). Each source file is parsed as a hub template considering {# and } as delimiters.

Generated Documentation

Annotations within comments are parsed to generate documentation.

lsn-javascript's People

Contributors

ryangies avatar ryan-gies-agilysys avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.