Asynchronously write javascript, even with document.write.
npm install postscribe
Remote scripts, especially ads, block the page from doing anything else while they load. They contribute a large % to load times which
affects your bottom line.
Asynchronous ads do not block the page and can be delivered after core
content - Async FTW.
Why is it so hard to deliver ads asynchronously? Because they may contain calls to document.write, which expects to be handled synchronously.
PostScribe lets you deliver a synchronous ad asynchronously without modifying the ad code.
Other tag writing libraries exist (see alternatives), but PostScribe is novel in its use of what we call DOM Proxies, a way to
ensure that the content is written as close to the way the browser would natively write the content with document.write/innerHTML. Read: it
behaves just like the browser would, without convoluted parsing or hacks.
For more information:
* Presentation at HTML5devconf by the original author, Derek Brans
* Interactive Demo with side by side comparisons of other tag writers
PostScribe overrides document.write. It is best and safest to use PostScribe after DOM is ready.
If you just want to use the script without installing anything, use the following to load the script from cdnjs:
``html`
You can include postscribe using npm:
`console`
npm install --save postscribe
Postscribe runs in browsers, so this assumes you're using a module bundler like webpack,
Browserify, JSPM or Rollup to consume CommonJS modules.
You can include postscribe using bower by installing from the CDN URL:
`console`
bower install --save https://cdnjs.cloudflare.com/ajax/libs/postscribe/2.0.6/postscribe.min.js
The library will exist at .
`javascript`
import postscribe from 'postscribe';
`javascript
define(['postscribe'], function(postscribe) {
});
`
`javascript`
var postscribe = require('postscribe');
To append html to #mydiv:
`javascript`
postscribe('#mydiv', 'Hello PostScribe
');
In general:
`javascript`
postscribe(element, html, options);
element:* a DOM Element, jQuery object, or id selector (e.g. "#mydiv")
html:* an html string or a function that takes a DOM Document and writes to it.
options:* a hash of options
afterAsync*: a callback called when an async script has loaded
afterDequeue*: a callback called immediately before removing from the write queue
afterStreamStart*: a callback called sync after a stream's first thread release
afterWrite*: a callback called after writing buffered document.write calls
done:* a callback that will be called when writing is finished
autoFix*: a boolean that allows disabling the autoFix feature of prescribe
beforeEnqueue*: a callback called immediately before adding to the write queue
beforeWriteToken*: a callback called before writing a token
beforeWrite*: a callback called before writing buffered document.write calls
error*: a function that throws the error by default, but could be overwritten
releaseAsync*: a boolean whether to let scripts w/ async attribute set fall out of the queue
If you just want to mess around, include the js files at the top of an html page that contains the following:
`html`
Where normally you would have
`html`Advertisement
Instead, remove the ad call and close the div
`htmlAdvertisement
`
There are some hooks you may pass as the third argument. For example:
`html`
See the beginning of postscribe.js for a complete list.
##### Does it work with jQuery, Prototype, Backbone, Underscore, jQuery UI, YUI, mooTools, dojo, etc.?
Yep. It neither depends on nor conflicts with any of the existing popular javascript frameworks.
##### Does it work with another tag writing library on the page?
No. Only one tag writer at a time.
This project was originally developed at Krux as part of its
SuperTag product.
There it has been battle tested on high-profile sites like The New York Times,
The Wall Street Journal, NBCU, and hundreds of others.
It is actively maintained by Krux.
PostScribe was designed to behave as closely to the native document.write/innerHTML does as possible, and we've taken great care to make sure
that it works on every browser we can get our hands on. We expect it to work on every browser built after 2009. There are over
500 unit tests that run on every commit. PostScribe is thoroughly tested and known to work well in the following browsers:
* Firefox 4+
* Chrome 10+
* Safari 5.0+
* Opera 10.0+
* Internet Explorer 8+
* iPhone/iPad and other WebKit-based browsers
Note that we do not provide any support for Internet Explorer versions earlier than IE8.
We've stood on the shoulders of giants with our work, and there are other alternative approaches to solve this problem. Shout out to the best
ones we found:
* writeCapture
* Ghostwriter by Digital Fulcrum
* ControlJS by Steve Souders
If you would like your project to be added to this list, file an issue and we'd be happy to.
We ♥ bug reports.
Have a problem? Need help? Would you like additional functionality added? We use GitHub's ticket system for keeping track of these requests.
Please check out the existing issues, and if you don't see that your problem is already being
worked on, please file a new issue. The more information the better to describe your problem.
We ♥ forks and pull requests.
Please see CONTRIBUTING.md for full details.
The project requires nodejs (>=5.6) and npm (>=3.6.0) for development. It has no runtime dependencies.
Check the code out and install the development dependencies using:
`console`
npm install
To build the code, run
`console`
npm run build
We use ESLint and JSCS to do static analysis of the JavaScript and keep things smelling good. To run both, use:
`console`
npm run lint
Using travis-ci, the unit tests are run on every commit using PhantomJS to run the tests
with a real browser.
To test the code locally, you can use:
`console`
npm test
To run tests in Test-Driven-Development mode, where the test will be run after every change, use:
`console`
npm run tdd
To run the cross-browser tests, use:
`console``
npm run test:cross-browser
Please either add a failing unit test or include a jsfiddle that distills and reproduces the issue.
Try forking this jsfiddle. We've set everything up there for you so that you can reproduce your issue.
We aim for you to use this inside your application, so we picked the least restrictive license we could find.
See LICENSE.