imgix-core-js adheres to the imgix-blueprint for definitions of its functionality.
imgix-core-js can be installed as either via npm or via bower:
$ npm install --save imgix-core-js
$ bower install --save imgix-core-js
Depending on your module system, using imgix-core-js is done a few different ways. The most common entry point will be the
Client class. Whenever you provide data to imgix-core-js, make sure it is not already URL-encoded, as the library handles proper encoding internally.
var ImgixClient = ;var client =host: "my-social-network.imgix.net"secureURLToken: "<SECURE TOKEN>";var url = client;console; // => "…"
let client =host: 'my-social-network.imgix.net'secureURLToken: '<SECURE TOKEN>';let url = client;console; // => '…'
var client =host: 'my-social-network.imgix.net'// Do not use signed URLs with `secureURLToken` on the client side,// as this would leak your token to the world. Signed URLs should// be generated on the server.;var url = client;console; // => ""
ixlibparam on every request?
For security and diagnostic purposes, we sign all requests with the language and version of library used to generate the URL.
This can be disabled by passing a falsy value for the
includeLibraryParam option to
host: 'my-source.imgix.net'includeLibraryParam: false;
imgix-core-js uses mocha for testing. Here’s how to run those tests:
To publish a new version of the NPM package:
$ npm publish
The Bower package will be automatically updated when you create a new release in GitHub.