jquery-once
Advanced tools
Comparing version 2.0.0-beta.3 to 2.0.0
74
API.md
@@ -1,20 +0,29 @@ | ||
#Index | ||
**Functions** | ||
* [once([id])](#once) | ||
* [removeOnce([id])](#removeOnce) | ||
* [findOnce([id])](#findOnce) | ||
##Globals | ||
<dl> | ||
<dt><a href="#once">once([id])</a> </dt> | ||
<dd><p>Filter elements that have yet to be processed by the given data ID.</p> | ||
</dd> | ||
<dt><a href="#removeOnce">removeOnce([id])</a> </dt> | ||
<dd><p>Removes the once data from elements, based on the given ID.</p> | ||
</dd> | ||
<dt><a href="#findOnce">findOnce([id])</a> </dt> | ||
<dd><p>Filters elements that have already been processed once.</p> | ||
</dd> | ||
</dl> | ||
<a name="once"></a> | ||
#once([id]) | ||
##once([id]) | ||
Filter elements that have yet to be processed by the given data ID. | ||
**Params** | ||
| Param | Type | Description | | ||
| ----- | ---- | ----------- | | ||
| \[id=<code>"once"</code>\] | <code>string</code> | The data ID used to determine whether the given elements have already been processed or not. Defaults to `"once"`. | | ||
- \[id="once"\] `string` - The data ID used to determine whether the given elements have already | ||
been processed or not. Defaults to `"once"`. | ||
**Returns**: jQuery collection of elements that have now run once by | ||
the given ID. | ||
**Access:** public | ||
**See** | ||
**Returns**: - jQuery collection of elements that have now run once by | ||
the given ID. | ||
- removeOnce | ||
- findOnce | ||
**Example** | ||
@@ -40,16 +49,17 @@ ``` javascript | ||
``` | ||
<a name="removeOnce"></a> | ||
#removeOnce([id]) | ||
##removeOnce([id]) | ||
Removes the once data from elements, based on the given ID. | ||
**Params** | ||
| Param | Type | Description | | ||
| ----- | ---- | ----------- | | ||
| \[id=<code>"once"</code>\] | <code>string</code> | A string representing the name of the data ID which should be used when filtering the elements. This only filters elements that have already been processed by the once function. The ID should be the same ID that was originally passed to the once() function. Defaults to `"once"`. | | ||
- \[id="once"\] `string` - A string representing the name of the data ID which should be used when | ||
filtering the elements. This only filters elements that have already been | ||
processed by the once function. The ID should be the same ID that was | ||
originally passed to the once() function. Defaults to `"once"`. | ||
**Returns**: jQuery collection of elements that were acted upon to remove their | ||
once data. | ||
**Access:** public | ||
**See** | ||
**Returns**: - jQuery collection of elements that were acted upon to remove their | ||
once data. | ||
- once | ||
**Example** | ||
@@ -66,15 +76,16 @@ ``` javascript | ||
``` | ||
<a name="findOnce"></a> | ||
#findOnce([id]) | ||
##findOnce([id]) | ||
Filters elements that have already been processed once. | ||
**Params** | ||
| Param | Type | Description | | ||
| ----- | ---- | ----------- | | ||
| \[id=<code>"once"</code>\] | <code>string</code> | A string representing the name of the data id which should be used when filtering the elements. This only filters elements that have already been processed by the once function. The id should be the same id that was originally passed to the once() function. Defaults to "once". | | ||
- \[id="once"\] `string` - A string representing the name of the data id which should be used when | ||
filtering the elements. This only filters elements that have already | ||
been processed by the once function. The id should be the same id that | ||
was originally passed to the once() function. Defaults to "once". | ||
**Returns**: jQuery collection of elements that have been run once. | ||
**Access:** public | ||
**See** | ||
**Returns**: - jQuery collection of elements that have been run once. | ||
- once | ||
**Example** | ||
@@ -93,2 +104,1 @@ ``` javascript | ||
``` | ||
/*! | ||
* jQuery Once v2.0.0-beta.3 - http://github.com/robloach/jquery-once | ||
* jQuery Once v2.0.0 - http://github.com/robloach/jquery-once | ||
* @license MIT, GPL-2.0 | ||
@@ -4,0 +4,0 @@ * http://opensource.org/licenses/MIT |
/*! | ||
* jQuery Once v2.0.0-beta.3 - http://github.com/robloach/jquery-once | ||
* jQuery Once v2.0.0 - http://github.com/robloach/jquery-once | ||
* @license MIT, GPL-2.0 | ||
@@ -4,0 +4,0 @@ * http://opensource.org/licenses/MIT |
@@ -9,3 +9,3 @@ { | ||
], | ||
"version": "2.0.0-beta.3", | ||
"version": "2.0.0", | ||
"author": { | ||
@@ -12,0 +12,0 @@ "name": "Rob Loach", |
@@ -5,3 +5,3 @@ { | ||
"description": "Act on jQuery elements only once.", | ||
"version": "2.0.0-beta.3", | ||
"version": "2.0.0", | ||
"keywords": [ | ||
@@ -16,3 +16,3 @@ "jquery", | ||
"daviddev": true, | ||
"gittip": "robloach" | ||
"npmdownloads": true | ||
}, | ||
@@ -55,9 +55,9 @@ "repo": "RobLoach/jquery-once", | ||
"devDependencies": { | ||
"eslint": "~0.11.0-alpha.0", | ||
"jsdoc-to-markdown": "^0.5.9", | ||
"jsdom": "^2.0.0", | ||
"mocha": "*", | ||
"mocha-jsdom": "^0.2.0", | ||
"projectz": "~0.3.15", | ||
"uglify-js": "~2.4.15" | ||
"eslint": "~0.12.0", | ||
"jsdoc-to-markdown": "~0.6.2", | ||
"jsdom": "~3.0.1", | ||
"mocha": "~2.1.0", | ||
"mocha-jsdom": "~0.2.0", | ||
"projectz": "~0.3.17", | ||
"uglify-js": "~2.4.16" | ||
}, | ||
@@ -69,4 +69,5 @@ "scripts": { | ||
"docs": "./node_modules/.bin/jsdoc2md jquery.once.js > API.md", | ||
"build": "./node_modules/.bin/uglifyjs jquery.once.js -o jquery.once.min.js --comments --source-map jquery.once.min.js.map --mangle" | ||
"build": "./node_modules/.bin/uglifyjs jquery.once.js -o jquery.once.min.js --comments --source-map jquery.once.min.js.map --mangle", | ||
"package": "npm install && npm run test && npm run projectz && npm run docs && npm run build" | ||
} | ||
} |
@@ -11,8 +11,9 @@ | ||
[![Build Status](http://img.shields.io/travis-ci/RobLoach/jquery-once.png?branch=master)](http://travis-ci.org/RobLoach/jquery-once "Check this project's build status on TravisCI") | ||
[![NPM version](http://badge.fury.io/js/jquery-once.png)](https://npmjs.org/package/jquery-once "View this project on NPM") | ||
[![Dependency Status](https://david-dm.org/RobLoach/jquery-once.png?theme=shields.io)](https://david-dm.org/RobLoach/jquery-once) | ||
[![Development Dependency Status](https://david-dm.org/RobLoach/jquery-once/dev-status.png?theme=shields.io)](https://david-dm.org/RobLoach/jquery-once#info=devDependencies)<br/> | ||
[![Gittip donate button](http://img.shields.io/gittip/robloach.png)](https://www.gittip.com/robloach/ "Donate weekly to this project using Gittip") | ||
[![Build Status](https://img.shields.io/travis/RobLoach/jquery-once/master.svg)](http://travis-ci.org/RobLoach/jquery-once "Check this project's build status on TravisCI") | ||
[![NPM version](https://img.shields.io/npm/v/jquery-once.svg)](https://npmjs.org/package/jquery-once "View this project on NPM") | ||
[![NPM downloads](https://img.shields.io/npm/dm/jquery-once.svg)](https://npmjs.org/package/jquery-once "View this project on NPM") | ||
[![Dependency Status](https://img.shields.io/david/RobLoach/jquery-once.svg)](https://david-dm.org/RobLoach/jquery-once) | ||
[![Dev Dependency Status](https://img.shields.io/david/dev/RobLoach/jquery-once.svg)](https://david-dm.org/RobLoach/jquery-once#info=devDependencies)<br/> | ||
<!-- /BADGES --> | ||
@@ -43,3 +44,3 @@ | ||
- Install: `npm install --save jquery-once` | ||
- CDN URL: `//wzrd.in/bundle/jquery-once@2.0.0-beta.3` | ||
- CDN URL: `//wzrd.in/bundle/jquery-once@2.0.0` | ||
@@ -90,4 +91,4 @@ ### [Ender](http://ender.jit.su/) | ||
git tag 2.0.0-alpha.3 | ||
git push origin 2.0.0-alpha.3 | ||
git tag 2.0.0 | ||
git push origin 2.0.0 | ||
npm publish | ||
@@ -132,4 +133,4 @@ | ||
[![Gittip donate button](http://img.shields.io/gittip/robloach.png)](https://www.gittip.com/robloach/ "Donate weekly to this project using Gittip") | ||
### Contributors | ||
@@ -136,0 +137,0 @@ |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
No v1
QualityPackage is not semver >=1. This means it is not stable and does not support ^ ranges.
Found 1 instance in 1 package
19742
0
145