Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.
Awesome Lists | Featured Topics | Projects
https://github.com/conversant/adlibs

A collection of cross-browser methods for use with front-end development, primarily for advertisers.
https://github.com/conversant/adlibs
Last synced: 5 days ago
JSON representation
A collection of cross-browser methods for use with front-end development, primarily for advertisers.
Host: GitHub
URL: https://github.com/conversant/adlibs
Owner: conversant
License: apache-2.0
Created: 2016-06-10T15:56:24.000Z (over 8 years ago)
Default Branch: master
Last Pushed: 2023-02-28T16:56:03.000Z (over 1 year ago)
Last Synced: 2024-10-30T15:07:11.724Z (16 days ago)
Language: JavaScript
Homepage: http://engineering.conversantmedia.com/
Size: 3.01 MB
Stars: 30
Watchers: 18
Forks: 3
Open Issues: 19
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project

README

        # AdLibs

[![Build Status](https://travis-ci.org/conversant/ad-libs.js.svg?branch=master)](https://travis-ci.org/conversant/ad-libs.js) [![Coverage Status](https://coveralls.io/repos/github/conversant/ad-libs.js/badge.svg)](https://coveralls.io/github/conversant/ad-libs.js) [![Code Climate](https://codeclimate.com/github/conversant/ad-libs.js/badges/gpa.svg)](https://codeclimate.com/github/conversant/ad-libs.js) [![Average time to resolve an issue](http://isitmaintained.com/badge/resolution/conversant/ad-libs.js.svg)](http://isitmaintained.com/project/conversant/ad-libs.js "Average time to resolve an issue") [![Percentage of issues still open](http://isitmaintained.com/badge/open/conversant/ad-libs.js.svg)](http://isitmaintained.com/project/conversant/ad-libs.js "Percentage of issues still open") [![Dependency Status](https://david-dm.org/conversant/ad-libs.js.svg?style=flat-square)](https://david-dm.org/conversant/ad-libs.js)

| ________________ | The gist of it... |

|:---|:---|

| ![adlibs](https://github.com/conversant/ad-libs.js/raw/master/doc/Ad-libs-js.png "Adlibs") | A collection of cross-browser methods for use with front-end development. adlibs is a tool that supports various browser and OS combinations dating back to IE9. It uses feature detection to determine the user's environment and outputs details pertaining to that OS and browser. adlibs also allows developers to safely execute front end methods such as domReady and XMLHttpRequests across all browsers. |

## Installation

```bash

npm install adlibs

```

## Usage

Each function is exported as a single commonjs module, allowing only the needed modules to be

bundled into a project to keep minified bundles as small as possible.

In Node.js:

```js

// Load the full adlibs build.

var adlibs = require('adlibs');

// Load a single module for smaller builds with webpack.

var domReady = require('adlibs/lib/dom/domReady');

var browser = require('adlibs/lib/detect/browser');

```

## Detection Modules

There are several modules that use feature detection to determine the user's environment. In order to populate the resulting

objects, the detect function must be executed.

For example, in order to populate the browser object:

```js

var browser = require('adlibs/lib/detect/browser').detect();

// outputs the name of the os

console.log(browser.os.name)

```

# API Reference

## Modules



canHas



comparableBits



This is due to Javascript using double-precision floating-point format numbers. If the number of bits in the bitmask is found to exceed the max supported, this module throws an error.





createSpy ⇒ sinon.spy





Helper method to create Sinon.JS spies directly on the value of module.exports for a required module. To spy on a method you need access to the object it is attached to, which is problematic when the function is directly returned from a "require" call. By accessing the require.cache we can get handle to the module's exports and inject the spy.



Browser



Browser Detection - Gets Data Pertaining to User's Browser and OS



Capabilities



Determines browser's capabilities (e.g. CORS support, sandboxable, video support, etc.)



Environment



Environment Detection - Gets Data Pertaining to User's Environment



Mraid



Mraid Detection



Safeframe



Safeframe Detection





addEventListener ⇒ function





Add an event listener to the element, which will execute the given callback.



appendHtml ⇒ Array



Appends all elements in the html string to the parent element. Correctly handles scripts with src attributes and inline javascript and ensures that the script will execute.

NOTE: Only Element nodes in the html string will be appended. All other node types will be ignored (i.e. Text, Comment).



domReady



Executes the provided callback when the DOM is ready. Allows code to act on the DOM before the window "load" event fires.



getExecutingScript



triggerEvent



Creates a new DOM Event and triggers it on the provided element.





evaluator ⇒ Object





Runs eval against the value passed to it. This function exists because eval prevents Uglify from minifying correctly.

    Encapsulating eval in its own module prevents the above issue. Variables and properties are one letter vars because Uglify won't function for this module.

    For more info on eval visit: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/eval





jsonp ⇒ Object





Perform a cross domain request via JSONP. Provides the same interface as xhr.js. The request is made by appending a 'callback' parameter to the request url, and it is expected that the server will respond with the content wrapped in a function call, using the provided value of the callback parameter. If callbackFn isn't defined, a unique name will be generated.



loadScript



Dynamically loads scripts in parallel, and executes a single callback after all scripts have loaded.



measurePerformance





parseConfig ⇒ Object





Parses a json config from the provided Element. The defaults is expected to be a JSON string in the attribute value.



perfMarker



A module to mark the timestamps for script performance



reportData





format ⇒ String





Constructs a URL from its parsed components. 1) Host takes precedence over hostname and port. 2) Query takes precedence over search.





parse ⇒ Object





Deconstructs a URL into its components. It also parses the search component (the query string) into decoded key/value pairs on a query object.



xhr



Cross browser wrapper for XMLHttpRequest. If you need Cookies and HTTP Auth data to be included in the request, you must set withCredentials to true in the options.





## Functions



insertAfter(elemToInsert, targetElem)



Utility Function to Insert 'elemToInsert' after 'targetElem' in the DOM



isAScript(inputElem)



Returns true if inputElem is a script element; false otherwise



addToDom(elem, target)



Adds 'elem' to the DOM with target/parent element 'target'

Scripts are treated differently than other elements because they have to be to work correctly





customCloneScript(inputScriptElem, win) ⇒ Element





Clones a script element in a way that is compatible with dynamic DOM-ready loading

Unfortunately, node.cloneNode() will not work in place of this function in this case

nor can it be used inside this function





cloneElem(elemToClone, win) ⇒ Node | Element





Creates a deep clone of the element passed in (with special logic for scripts)

Scripts have to be handled differently because the script code will not execute unless they are processed this way





recursiveCloneAndAddToDom(inputElem, targetElem, win) ⇒ Node | Element





Recursively iterates through 'inputElem' child elements, creates clones of them, and attaches them to 'targetElem'

Why? Because script elements (including nested ones) need to be cloned a specific way in order for the code they represent to be executed.





insertInlineHtmlString(htmlString, [parentElem], win) ⇒ boolean





Adds 'htmlString' as a child to element 'parentElem' in a way that's safe to use after the document has been closed





createInsContainer(win) ⇒ HTMLModElement





Returns an 'ins' element with a unique ID and class 'adlibs-ins'





docWriteHtmlString(htmlString, win) ⇒ boolean





Uses document.writeln to add an HTML string to the page





isNativeFunction(value) ⇒ any





Returns true if a function is the native implementation; false otherwise



embedHtml(htmlString, [parentElem], [callback], [win])



If the doc readyState is complete or interactive, use custom methods to safely write 'htmlString' to the page; otherwise, use native document.write







## canHas

* [canHas](#module_canHas)

    * [.can(obj, propertyName)](#module_canHas.can) ⇒ Boolean

    * [.has(globalObjectName, [scope])](#module_canHas.has) ⇒ \*

    * [.own(obj, propertyName)](#module_canHas.own) ⇒ Boolean

    * [.run(obj, [methodName])](#module_canHas.run) ⇒ function

    * [.forIn(obj, callback)](#module_canHas.forIn)

    * [.keys(obj)](#module_canHas.keys) ⇒ \*



### canHas.can(obj, propertyName) ⇒ Boolean

Can this object use this property?

**Kind**: static method of [canHas](#module_canHas)  

| Param |

| --- |

| obj | 

| propertyName | 

**Example**  

```js

var can = require('adlibs/lib/canHas').can;

```



### canHas.has(globalObjectName, [scope]) ⇒ \*

Does this window have this object in it?

**Kind**: static method of [canHas](#module_canHas)  

| Param | Description |

| --- | --- |

| globalObjectName |  |

| [scope] | Alternatively, you can call "run" with a more sane method signature. |

**Example**  

```js

var has = require('adlibs/lib/canHas').has;

```



### canHas.own(obj, propertyName) ⇒ Boolean

Check to see if this object owns the method as opposed to just inheriting it from another object.

**Kind**: static method of [canHas](#module_canHas)  

| Param |

| --- |

| obj | 

| propertyName | 



### canHas.run(obj, [methodName]) ⇒ function

Return a runnable method by default.

**Kind**: static method of [canHas](#module_canHas)  

| Param | Description |

| --- | --- |

| obj | Scope to use, or method to run when not providing a method as the second param. |

| [methodName] | The method to check for. |



### canHas.forIn(obj, callback)

For each in, shorthanded because manually writing hasOwnProperty each and every time is not a good use of time.

**Kind**: static method of [canHas](#module_canHas)  

| Param |

| --- |

| obj | 

| callback | 



### canHas.keys(obj) ⇒ \*

A substitute for Object.keys for when browsers don't attempt to convert non-objects to arrays

**Kind**: static method of [canHas](#module_canHas)  

| Param |

| --- |

| obj | 



## comparableBits

This is due to Javascript using double-precision floating-point format numbers. If the number of bits in the bitmask is found to exceed the max supported, this module throws an error.

* [comparableBits](#module_comparableBits)

    * [.factory](#module_comparableBits.factory) ⇒ ComparableBits

    * [.provider](#module_comparableBits.provider) ⇒ ComparableBits

    * [.make(bit, [data])](#module_comparableBits.make) ⇒ Action

    * [.compare(action, bitSig, [callback])](#module_comparableBits.compare) ⇒ Boolean



### comparableBits.factory ⇒ ComparableBits

Create a new instance of the ComparableBits module.

**Kind**: static property of [comparableBits](#module_comparableBits)  

**Example**  

```js

var bits = require('adlibs/lib/comparableBits').factory();

var someAction = bits.make(0x1 | 0x2, 'flag1,mode1or2')

bits.compare(someAction, 0x1, callback) // -> executes callback

```



### comparableBits.provider ⇒ ComparableBits

Tie into an existing instance of the ComparableBits module.

**Kind**: static property of [comparableBits](#module_comparableBits)  

| Param |

| --- |

| packageName | 



### comparableBits.make(bit, [data]) ⇒ Action

Creates the action object with it's attributed bitmask flag

**Kind**: static method of [comparableBits](#module_comparableBits)  

**Returns**: Action - Returns the created Action object  

| Param | Type | Description |

| --- | --- | --- |

| bit | Number | The actions's unique bitmask |

| [data] | String | The action's label |

**Example**  

```js

var make = require('adlibs/lib/comparableBits').make;

```



### comparableBits.compare(action, bitSig, [callback]) ⇒ Boolean

Encapsulates a bitmask service which takes a bitmask and compares it to the attributed action's flag

**Kind**: static method of [comparableBits](#module_comparableBits)  

**Returns**: Boolean - Returns true if the action's flags do match either of the provided bitmasks  

| Param | Type | Description |

| --- | --- | --- |

| action | Action | The action object to compare to the provided bitmasks |

| bitSig | Number | Should have a unique bit signature for bit logic |

| [callback] | \* | The action's pertaining data |

**Example**  

```js

var compare = require('adlibs/lib/comparableBits').compare;

```



## createSpy ⇒ sinon.spy

Helper method to create Sinon.JS spies directly on the value of module.exports for a required module. To spy on a method you need access to the object it is attached to, which is problematic when the function is directly returned from a "require" call. By accessing the require.cache we can get handle to the module's exports and inject the spy.

| Param | Type | Description |

| --- | --- | --- |

| loadedModule |  |  |

| mockType | String | Defaults to 'spy'; can also be 'stub'. |

**Example**  

incrementCounter.js:

```js

module.exports = function() { ... async call ...  };

```

my-test.js

```js

var incrementCounter = require('./incrementCounter'),

createSpy = require('cse-common/lib/createSpy');

var spy = createSpy(incrementCounter);

// test code

assert(spy.callCount, 4);

spy.restore();

```



## Browser

Browser Detection - Gets Data Pertaining to User's Browser and OS

**Example**  

```

var browser = require("adlibs/lib/detect/browser")

```

* [Browser](#module_Browser)

    * _static_

        * [.mathMLSupport(d)](#module_Browser.mathMLSupport) ⇒ Boolean

        * [.isMobile([win])](#module_Browser.isMobile) ⇒ Boolean

        * [.getVersion(uaVersion, minVersion, [maxVersion])](#module_Browser.getVersion) ⇒ Number

        * [.looksLike(regex, ua)](#module_Browser.looksLike) ⇒ \* \| Boolean

        * [.parseIntIfMatch(ua, regex, [radix])](#module_Browser.parseIntIfMatch) ⇒ Number

        * [.parseFloatIfMatch(ua, regex)](#module_Browser.parseFloatIfMatch) ⇒

        * [.getAndroidVersion(win, uaVersion)](#module_Browser.getAndroidVersion) ⇒ Number

        * [.getChromiumVersion(win, uaVersion)](#module_Browser.getChromiumVersion) ⇒ Number

        * [.getSafariVersion(win, uaVersion)](#module_Browser.getSafariVersion) ⇒ Number

        * [.getKindleVersion(win, uaVersion)](#module_Browser.getKindleVersion) ⇒ Number

        * [.getOtherOS(win, ua)](#module_Browser.getOtherOS) ⇒ Browser

        * [.getAppleOS(win, ua)](#module_Browser.getAppleOS) ⇒ Browser

        * [.getMicrosoftOS(win, ua)](#module_Browser.getMicrosoftOS) ⇒ Browser

        * [.getAndroidOS(win, ua)](#module_Browser.getAndroidOS) ⇒ Browser

        * [.getKindleOS(win, ua)](#module_Browser.getKindleOS) ⇒ Browser

        * [.getOsFromUa(win, ua)](#module_Browser.getOsFromUa) ⇒ Browser

        * [.detect([win], [userAgent])](#module_Browser.detect) ⇒ Browser

        * [.read(key)](#module_Browser.read) ⇒ \*

    * _inner_

        * [~save(result)](#module_Browser..save) ⇒ Number



### browser.mathMLSupport(d) ⇒ Boolean

Check for MathML support in browsers to help detect certain browser version numbers where this is the only difference.

**Kind**: static method of [Browser](#module_Browser)  

**Returns**: Boolean - returns true if browser has mathml support  

| Param | Type |

| --- | --- |

| d | Document | 



### browser.isMobile([win]) ⇒ Boolean

Performs a simple test to see if we're on mobile or not.

**Kind**: static method of [Browser](#module_Browser)  

**Returns**: Boolean - returns true if mobile  

| Param | Type |

| --- | --- |

| [win] | Window | 



### browser.getVersion(uaVersion, minVersion, [maxVersion]) ⇒ Number

Uses the min and max versions of a browser to determine its version.

**Kind**: static method of [Browser](#module_Browser)  

**Returns**: Number - returns version number  

| Param | Type |

| --- | --- |

| uaVersion | Number | 

| minVersion | Number | 

| [maxVersion] | Number | 



### browser.looksLike(regex, ua) ⇒ \* \| Boolean

Searches for a match between the regex and specified string.

**Kind**: static method of [Browser](#module_Browser)  

**Returns**: \* \| Boolean - returns true if match found  

| Param | Type |

| --- | --- |

| regex | RegExp | 

| ua | String | 



### browser.parseIntIfMatch(ua, regex, [radix]) ⇒ Number

Parses the result of the RegExp match if it exists.

Gracefully falls back to the default version if not.

**Kind**: static method of [Browser](#module_Browser)  

**Returns**: Number - returns the regex match or default version  

| Param | Type |

| --- | --- |

| ua | String | 

| regex | RegExp | 

| [radix] | Number | 



### browser.parseFloatIfMatch(ua, regex) ⇒

Parses the floating point value of the RegExp match if found.

Gracefully falls back to the default if not.

**Kind**: static method of [Browser](#module_Browser)  

**Returns**: returns the regex match or the default version  

| Param | Type |

| --- | --- |

| ua | String | 

| regex | RegExp | 



### browser.getAndroidVersion(win, uaVersion) ⇒ Number

Determines the version of Android being used.

**Kind**: static method of [Browser](#module_Browser)  

**Returns**: Number - returns the Android version  

| Param | Type |

| --- | --- |

| win | Window | 

| uaVersion | Number | 



### browser.getChromiumVersion(win, uaVersion) ⇒ Number

Determines the version of Chrome being used.

**Kind**: static method of [Browser](#module_Browser)  

**Returns**: Number - returns the Chrome version  

| Param | Type |

| --- | --- |

| win | Window | 

| uaVersion | Number | 



### browser.getSafariVersion(win, uaVersion) ⇒ Number

Returns the version of the Safari browser.

**Kind**: static method of [Browser](#module_Browser)  

**Returns**: Number - returns the version of Safari  

| Param | Type |

| --- | --- |

| win | Window | 

| uaVersion | Number | 



### browser.getKindleVersion(win, uaVersion) ⇒ Number

Creates a Browser instance with its attributed Kindle values.

**Kind**: static method of [Browser](#module_Browser)  

| Param | Type |

| --- | --- |

| win | Window | 

| uaVersion | Number | 



### browser.getOtherOS(win, ua) ⇒ Browser

Creates a Browser instance with its attributed OS and device type values.

**Kind**: static method of [Browser](#module_Browser)  

**Returns**: Browser - returns the browser instance  

| Param | Type |

| --- | --- |

| win | Window | 

| ua | String | 



### browser.getAppleOS(win, ua) ⇒ Browser

Creates a Browser instance with its attributed Apple values.

**Kind**: static method of [Browser](#module_Browser)  

**Returns**: Browser - returns the Browser instance  

| Param | Type |

| --- | --- |

| win | Window | 

| ua | String | 



### browser.getMicrosoftOS(win, ua) ⇒ Browser

Creates a Browser instance with its attributed Windows values.

**Kind**: static method of [Browser](#module_Browser)  

**Returns**: Browser - returns the Browser instance  

| Param | Type |

| --- | --- |

| win | Window | 

| ua | String | 



### browser.getAndroidOS(win, ua) ⇒ Browser

Creates a Browser instance with its attributed Android values.

**Kind**: static method of [Browser](#module_Browser)  

**Returns**: Browser - returns the Browser instance  

| Param | Type |

| --- | --- |

| win | Window | 

| ua | String | 



### browser.getKindleOS(win, ua) ⇒ Browser

Returns the Kindle's OS.

**Kind**: static method of [Browser](#module_Browser)  

**Returns**: Browser - returns the Browser instance  

| Param | Type |

| --- | --- |

| win | Window | 

| ua | String | 



### browser.getOsFromUa(win, ua) ⇒ Browser

Reads the user agent string to determine OS.

**Kind**: static method of [Browser](#module_Browser)  

**Returns**: Browser - returns the Browser instance  

| Param | Type |

| --- | --- |

| win | Window | 

| ua | String | 



### browser.detect([win], [userAgent]) ⇒ Browser

Returns an object containing browser details (e.g. name, os, version, etc.).

**Kind**: static method of [Browser](#module_Browser)  

**Returns**: Browser - returns the Browser instance  

| Param | Type |

| --- | --- |

| [win] | Window | 

| [userAgent] | String | 

**Example**  

```js

var os = browser.detect().os.name;

console.log(os); // outputs OS name (e.g. Windows, Mac, Android, etc.)

```



### browser.read(key) ⇒ \*

Retrieve any results in the map by name because they're returned in an array without names.

**Kind**: static method of [Browser](#module_Browser)  

| Param | Type |

| --- | --- |

| key | String | 



### Browser~save(result) ⇒ Number

Saves a property to the results array and returns its index.

**Kind**: inner method of [Browser](#module_Browser)  

| Param | Type |

| --- | --- |

| result | \* | 



## Capabilities

Determines browser's capabilities (e.g. CORS support, sandboxable, video support, etc.)

**Example**  

```javascript

var capabilities = require("adlibs/lib/detect/capabilities");

```



### capabilities.detect() ⇒ Object

Detects browser's capabilities and returns an object.

**Kind**: static method of [Capabilities](#module_Capabilities)  

**Example**  

```js

// Outputs whether the browser supports h264 video ( 1 if yes, else 0)

var h264 = capabilities.detect().h264;

```



## Environment

Environment Detection - Gets Data Pertaining to User's Environment

**Example**  

```

var environment = require("adlibs/lib/detect/environment");

```

* [Environment](#module_Environment)

    * [.detect()](#module_Environment.detect) ⇒ Object

    * [.getFlashVersion()](#module_Environment.getFlashVersion) ⇒ Number

    * [.getFrameDepth()](#module_Environment.getFrameDepth) ⇒ String

    * [.getAvailableScreenSize()](#module_Environment.getAvailableScreenSize) ⇒ Object

    * [.getScreenSize()](#module_Environment.getScreenSize) ⇒ Object

    * [.getAdDocSize()](#module_Environment.getAdDocSize) ⇒ Object



### environment.detect() ⇒ Object

Detect environmental variables and return them wrapped within an object.

**Kind**: static method of [Environment](#module_Environment)  

**Returns**: Object - returns the environment object  

**Example**  

```js

var flash = environment.detect().flash;

console.log(flash) // outputs the version of Flash

```



### environment.getFlashVersion() ⇒ Number

**Kind**: static method of [Environment](#module_Environment)  



### environment.getFrameDepth() ⇒ String

**Kind**: static method of [Environment](#module_Environment)  



### environment.getAvailableScreenSize() ⇒ Object

**Kind**: static method of [Environment](#module_Environment)  



### environment.getScreenSize() ⇒ Object

**Kind**: static method of [Environment](#module_Environment)  



### environment.getAdDocSize() ⇒ Object

**Kind**: static method of [Environment](#module_Environment)  



## Mraid

Mraid Detection

**Example**  

```js

var mraid = require("adlibs/lib/detect/mraid");

console.log(mraid.getVersion()) // outputs mraid version;

```

* [Mraid](#module_Mraid)

    * [.ready(cb, [If])](#module_Mraid.ready)

    * [.getVersion([If])](#module_Mraid.getVersion) ⇒ String

    * [.diagnostic(win)](#module_Mraid.diagnostic) ⇒ Object



### mraid.ready(cb, [If])

Executes cb when mraid is ready.

**Kind**: static method of [Mraid](#module_Mraid)  

| Param | Type | Description |

| --- | --- | --- |

| cb | function |  |

| [If] | Window | not given, uses the current window. |



### mraid.getVersion([If]) ⇒ String

Gets mraid version.

**Kind**: static method of [Mraid](#module_Mraid)  

| Param | Type | Description |

| --- | --- | --- |

| [If] | Window | not given, uses the current window. |



### mraid.diagnostic(win) ⇒ Object

**Kind**: static method of [Mraid](#module_Mraid)  

| Param | Type | Description |

| --- | --- | --- |

| win | Object | Window Object |



## Safeframe

Safeframe Detection

**Example**  

```js

var safeframe = require("adlibs/lib/detect/safeframe");

```

* [Safeframe](#module_Safeframe)

    * [.getVersion([win])](#module_Safeframe.getVersion) ⇒ String

    * [.getSpecVersion([win])](#module_Safeframe.getSpecVersion) ⇒ String

    * [.getInfo([win])](#module_Safeframe.getInfo) ⇒ Array

    * [.getConf([win])](#module_Safeframe.getConf) ⇒ Array

    * [.getSupport([win])](#module_Safeframe.getSupport) ⇒ Array

    * [.getInView([win])](#module_Safeframe.getInView) ⇒ Number

    * [.getWinFocus([win])](#module_Safeframe.getWinFocus) ⇒ Number

    * [.getMetrics([win])](#module_Safeframe.getMetrics) ⇒ Array



### Safeframe.getVersion([win]) ⇒ String

Get version of safeframe.

**Kind**: static method of [Safeframe](#module_Safeframe)  

| Param | Type |

| --- | --- |

| [win] | Window | 



### Safeframe.getSpecVersion([win]) ⇒ String

Gets specVersion of safeframe.

**Kind**: static method of [Safeframe](#module_Safeframe)  

| Param | Type |

| --- | --- |

| [win] | Window | 



### Safeframe.getInfo([win]) ⇒ Array

Gets info of safeframe.

**Kind**: static method of [Safeframe](#module_Safeframe)  

| Param | Type |

| --- | --- |

| [win] | Window | 



### Safeframe.getConf([win]) ⇒ Array

Gets config of safeframe host.

**Kind**: static method of [Safeframe](#module_Safeframe)  

| Param | Type |

| --- | --- |

| [win] | Window | 



### Safeframe.getSupport([win]) ⇒ Array

Returns array of supported fields for sf.ext.

**Kind**: static method of [Safeframe](#module_Safeframe)  

| Param | Type |

| --- | --- |

| [win] | Window | 



### Safeframe.getInView([win]) ⇒ Number

Gets inview percentage of safeframe.

**Kind**: static method of [Safeframe](#module_Safeframe)  

| Param | Type |

| --- | --- |

| [win] | Window | 



### Safeframe.getWinFocus([win]) ⇒ Number

Returns if safeframe window has focus.

**Kind**: static method of [Safeframe](#module_Safeframe)  

| Param | Type |

| --- | --- |

| [win] | Window | 



### Safeframe.getMetrics([win]) ⇒ Array

Returns safeframe metrics.

**Kind**: static method of [Safeframe](#module_Safeframe)  

| Param | Type |

| --- | --- |

| [win] | Window | 



## addEventListener ⇒ function

Add an event listener to the element, which will execute the given callback.

**Returns**: function - returns a function that, when executed, will remove the event listener from the element  

| Param | Type |

| --- | --- |

| element | Element | 

| eventName | String | 

| callback | function | 

**Example**  

```js

var addEventListener = require('adlibs/lib/dom/addEventListener');

addEventListener(el, 'onLoad', cb);

```



## ~~appendHtml ⇒ Array~~

***Deprecated***

Appends all elements in the html string to the parent element. Correctly handles scripts with src attributes and inline javascript and ensures that the script will execute.

NOTE: Only Element nodes in the html string will be appended. All other node types will be ignored (i.e. Text, Comment).

**Returns**: Array - returns a list of any exceptions that occurred  

**Note**: This module is deprecated but remains for backwards compatibility; please use 'embedHtml' instead  

| Param | Type |

| --- | --- |

| parentEl | Element | 

| html | String | 

**Example**  

```js

var appendHtml = require('adlibs/lib/dom/appendHtml');

appendHtml(parentElement, htmlMarkup);

```



## domReady

Executes the provided callback when the DOM is ready. Allows code to act on the DOM before the window "load" event fires.

| Param | Type | Description |

| --- | --- | --- |

| callback | function |  |

| [targetWindow] | Window | You can provide your own window reference for cases where you'd have an iframe. |

| [isInteractiveOk] | Boolean | Interactive mode can be checked for faster responses. |

**Example**  

```js

var domReady = require('adlibs/lib/dom/domReady');

// executes the cb on dom ready

domReady(cb, window);

```



## getExecutingScript



### getExecutingScript~getExecutingScript([validatorFunc], [testScript]) ⇒ HTMLScriptElement \| null

Returns the script element that loaded the currently executing javascript code.

The validatorFunc function takes a script Element as a single argument, and should

return a boolean value. Allows more specific filtering in the case of multiple

scripts on the page where document.currentScript is not supported.

When the executing script has been located, it will be marked with an attribute

key/value pair represented at getExecutingScript.LOAD_ATTR and getExecutingScript.LOAD_STARTED.

**Kind**: inner method of [getExecutingScript](#module_getExecutingScript)  

| Param | Type | Description |

| --- | --- | --- |

| [validatorFunc] | function |  |

| [testScript] | HTMLScriptElement | Used for IoC/testing. |



## triggerEvent

Creates a new DOM Event and triggers it on the provided element.

| Param | Type |

| --- | --- |

| element | Element | 

| eventName | String | 



## evaluator ⇒ Object

Runs eval against the value passed to it. This function exists because eval prevents Uglify from minifying correctly.

	Encapsulating eval in its own module prevents the above issue. Variables and properties are one letter vars because Uglify won't function for this module.

	For more info on eval visit: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/eval

**Returns**: Object - evalResult  

| Param | Type |

| --- | --- |

| scriptString | String | 



## jsonp ⇒ Object

Perform a cross domain request via JSONP. Provides the same interface as xhr.js. The request is made by appending a 'callback' parameter to the request url, and it is expected that the server will respond with the content wrapped in a function call, using the provided value of the callback parameter. If callbackFn isn't defined, a unique name will be generated.

**Returns**: Object - returns object with send function  

| Param | Type | Description |

| --- | --- | --- |

| options | Object |  |

| callback | function | Executed on response with the signature (status: Number, body: String). |

**Example**  

```js

// for call -> http://example.com/?callback=CB_1433519761916

// the following gets executed

CB_1433519761916('response from server');

```



## loadScript

Dynamically loads scripts in parallel, and executes a single callback after all scripts have loaded.

| Param | Type | Description |

| --- | --- | --- |

| urls | String \| Array | A single url, or a list of urls of scripts to load. |

| onLoaded | function | Callback is executed when all scripts have finished loading. |

| onError | function | Callback is executed if one or more scripts fail to load, and passed 							  a single argument: the list of script urls that failed to load. |

| [requestTimeout] | Number | When supplied, this will explicitly timeout the script request 							  and report back to onError, or, if onError is not supplied, to onLoaded. 							  IMPORTANT: This does not cancel the script load, just reports that it 							  has exceeded the timeout duration. |



## measurePerformance

* [measurePerformance](#module_measurePerformance)

    * [.factory](#module_measurePerformance.factory) ⇒ MeasurePerformance

    * [.provider](#module_measurePerformance.provider) ⇒ MeasurePerformance



### measurePerformance.factory ⇒ MeasurePerformance

Create a new instance of the performance module.

**Kind**: static property of [measurePerformance](#module_measurePerformance)  

**Example**  

```js

var perf = require('adlibs/lib/measurePerformance').factory();

console.log(perf.now() - perf.startTime); // outputs duration since script start

console.log(perf.report()); // outputs report based on performance events such as domLoading, navigationStart, etc.

```



### measurePerformance.provider ⇒ MeasurePerformance

Tie into an existing instance of the performance module.

**Kind**: static property of [measurePerformance](#module_measurePerformance)  

| Param |

| --- |

| packageName | 



## parseConfig ⇒ Object

Parses a json config from the provided Element. The defaults is expected to be a JSON string in the attribute value.

**Returns**: Object - returns the parsed json config  

| Param | Type | Description |

| --- | --- | --- |

| el | Element | The HTML Element that contains the config defaults. |

| attrName | String |  |

| [defaults] | Object |  |

**Example**  

```js

var parseConfig = require('adlibs/lib/parseConfig');

console.log(parseConfig(htmlElement, attributeName, defaultVals)) // outputs the parsed object from the element

```



## perfMarker

A module to mark the timestamps for script performance

* [perfMarker](#module_perfMarker)

    * [.factory](#module_perfMarker.factory) ⇒ PerfMarker

    * [.provider](#module_perfMarker.provider) ⇒ PerfMarker



### perfMarker.factory ⇒ PerfMarker

Creates a new instance of PerfMarker.

**Kind**: static property of [perfMarker](#module_perfMarker)  



### perfMarker.provider ⇒ PerfMarker

Ties into an existing instance of PerfMarker.

**Kind**: static property of [perfMarker](#module_perfMarker)  

| Param | Type | Description |

| --- | --- | --- |

| [pkgName] | String | The name of the instance. |



## reportData

* [reportData](#module_reportData)

    * _static_

        * [.factory](#module_reportData.factory) ⇒ ReportData

        * [.provider](#module_reportData.provider) ⇒ ReportData

    * _inner_

        * [~xhrTrack(trackURL)](#module_reportData..xhrTrack) ⇒ String

        * [~imgTrack(trackURL)](#module_reportData..imgTrack)

        * [~isChrome()](#module_reportData..isChrome) ⇒ boolean

        * [~isSafari()](#module_reportData..isSafari) ⇒ boolean

        * [~objectToQueryString(params)](#module_reportData..objectToQueryString) ⇒ String

        * [~isSendBeaconAvailable()](#module_reportData..isSendBeaconAvailable) ⇒ Boolean

        * [~sendReport([url], [isUnloadEvent], [sendBeaconJsonString])](#module_reportData..sendReport) ⇒ \*



### reportData.factory ⇒ ReportData

Create a new instance of the reportData module.

**Kind**: static property of [reportData](#module_reportData)  

| Param | Type | Description |

| --- | --- | --- |

| [baseURL] | String | Base url for reporting pixel info. |

| [measurePerformanceInstance] | MeasurePerformance | Performance instance to provide measurement timestamps. |



### reportData.provider ⇒ ReportData

Tie into an existing instance of the reportData module.

**Kind**: static property of [reportData](#module_reportData)  

| Param |

| --- |

| packageName | 



### reportData~xhrTrack(trackURL) ⇒ String

Safari can't use tracking pixels on unload, but xhr is said to work. Caveat is it's a sync call so it hangs the browser a split second.

**Kind**: inner method of [reportData](#module_reportData)  

| Param | Type |

| --- | --- |

| trackURL | String | 



### reportData~imgTrack(trackURL)

This method makes a call to a url but does not actually draw a pixel to a page in any way.

The image will be cleaned up by the browser easily because it's not referenced again past this point.

**Kind**: inner method of [reportData](#module_reportData)  

| Param | Type | Description |

| --- | --- | --- |

| trackURL | String | returns {String} |



### reportData~isChrome() ⇒ boolean

Returns true if browser is Chrome; false otherwise

**Kind**: inner method of [reportData](#module_reportData)  



### reportData~isSafari() ⇒ boolean

Returns true if browser is Safari; false otherwise

**Kind**: inner method of [reportData](#module_reportData)  



### reportData~objectToQueryString(params) ⇒ String

Iterate over an object literal's properties and convert those to a string to be appended to a url

**Kind**: inner method of [reportData](#module_reportData)  

| Param | Type | Description |

| --- | --- | --- |

| params | Object | key/value pairs to convert into a query string |



### reportData~isSendBeaconAvailable() ⇒ Boolean

Utility function to determine if sendBeacon is natively supprted

**Kind**: inner method of [reportData](#module_reportData)  



### reportData~sendReport([url], [isUnloadEvent], [sendBeaconJsonString]) ⇒ \*

Sends data utilizing sendBeacon if selected and available

**Kind**: inner method of [reportData](#module_reportData)  

| Param | Type | Description |

| --- | --- | --- |

| [url] | String |  |

| [isUnloadEvent] | Boolean |  |

| [sendBeaconJsonString] | String | Json formated string of data to send |



## format ⇒ String

Constructs a URL from its parsed components. 1) Host takes precedence over hostname and port. 2) Query takes precedence over search.

| Param | Type | Description |

| --- | --- | --- |

| components | Object | The url components, as generated by url/parse.js. |



## parse ⇒ Object

Deconstructs a URL into its components. It also parses the search component (the query string) into decoded key/value pairs on a query object.

| Param | Type |

| --- | --- |

| url | String | 

**Example**  

```js

var parseUrl = require('adlibs/lib/url/parse');

var queryObj = parseUrl('http://example.com/query?cb=1234&userid=9999');

```



## xhr

Cross browser wrapper for XMLHttpRequest. If you need Cookies and HTTP Auth data to be included in the request, you must set withCredentials to true in the options.

**Example**  

```js

var xhr = require('adlibs/lib/xhr');

```

* [xhr](#module_xhr)

    * _static_

        * [.supportsCORS()](#module_xhr.supportsCORS) ⇒ Boolean

    * _inner_

        * [~xhr(options, callback)](#module_xhr..xhr) ⇒ Object



### xhr.supportsCORS() ⇒ Boolean

Determines if CORS is supported.

**Kind**: static method of [xhr](#module_xhr)  

**Returns**: Boolean - returns whether CORS is supported  



### xhr~xhr(options, callback) ⇒ Object

**Kind**: inner method of [xhr](#module_xhr)  

| Param | Type | Description |

| --- | --- | --- |

| options | Object |  |

| callback | function | Executed on response with the signature (status: Number, body: String). |

**Example**  

```js

// performs a GET request

var resp = xhr({url: 'www.example.com'}).send();

```



## insertAfter(elemToInsert, targetElem)

Utility Function to Insert 'elemToInsert' after 'targetElem' in the DOM

**Kind**: global function  

| Param |

| --- |

| elemToInsert | 

| targetElem | 



## isAScript(inputElem)

Returns true if inputElem is a script element; false otherwise

**Kind**: global function  

| Param | Type |

| --- | --- |

| inputElem | Node \| Element | 



## addToDom(elem, target)

Adds 'elem' to the DOM with target/parent element 'target'

Scripts are treated differently than other elements because they have to be to work correctly

**Kind**: global function  

| Param |

| --- |

| elem | 

| target | 



## customCloneScript(inputScriptElem, win) ⇒ Element

Clones a script element in a way that is compatible with dynamic DOM-ready loading

Unfortunately, node.cloneNode() will not work in place of this function in this case

nor can it be used inside this function

**Kind**: global function  

| Param | Type | Description |

| --- | --- | --- |

| inputScriptElem | Element | Input Script Element |

| win | Object |  |



## cloneElem(elemToClone, win) ⇒ Node \| Element

Creates a deep clone of the element passed in (with special logic for scripts)

Scripts have to be handled differently because the script code will not execute unless they are processed this way

**Kind**: global function  

| Param | Type |

| --- | --- |

| elemToClone |  | 

| win | Object | 



## recursiveCloneAndAddToDom(inputElem, targetElem, win) ⇒ Node \| Element

Recursively iterates through 'inputElem' child elements, creates clones of them, and attaches them to 'targetElem'

Why? Because script elements (including nested ones) need to be cloned a specific way in order for the code they represent to be executed.

**Kind**: global function  

| Param | Type |

| --- | --- |

| inputElem | Node \| Element | 

| targetElem | Node \| Element | 

| win | Object | 



## insertInlineHtmlString(htmlString, [parentElem], win) ⇒ boolean

Adds 'htmlString' as a child to element 'parentElem' in a way that's safe to use after the document has been closed

**Kind**: global function  

| Param | Type | Description |

| --- | --- | --- |

| htmlString | String | HTML String to Add to the page |

| [parentElem] | Node \| Element | Parent element to attach 'htmlString' as a child to; defaults to document.body |

| win | Object |  |



## createInsContainer(win) ⇒ HTMLModElement

Returns an 'ins' element with a unique ID and class 'adlibs-ins'

**Kind**: global function  

| Param | Type |

| --- | --- |

| win | Object | 



## docWriteHtmlString(htmlString, win) ⇒ boolean

Uses document.writeln to add an HTML string to the page

**Kind**: global function  

| Param | Type | Description |

| --- | --- | --- |

| htmlString | string | HTML String to Add to the page |

| win | Object |  |



## isNativeFunction(value) ⇒ any

Returns true if a function is the native implementation; false otherwise

**Kind**: global function  

**Ref**: https://davidwalsh.name/detect-native-function  

| Param | Type |

| --- | --- |

| value | function | 



## embedHtml(htmlString, [parentElem], [callback], [win])

If the doc readyState is complete or interactive, use custom methods to safely write 'htmlString' to the page; otherwise, use native document.write

**Kind**: global function  

| Param | Type | Description |

| --- | --- | --- |

| htmlString | string |  |

| [parentElem] | HTMLElement | Parent element to attach 'htmlString' as a child to (this is only used if the document readyState is complete or interactive) |

| [callback] | function | Callback function |

| [win] | Object | Optional window reference to write into |

# adlibs Developers

* [j-brown](https://github.com/j-brown)

* [msahagu2](https://github.com/msahagu2)

* [ericperez](https://github.com/ericperez)

* [gblosser](https://github.com/gblosser42)

* [jeffreytgilbert](https://github.com/jeffreytgilbert)

* [ggustilo](https://github.com/ggustilo)

* [larrymyers](https://github.com/larrymyers)

* * *