categorised-url.js v2.0.0

categorised-url.js

Categorises URLs and extracts inferable meta-data from them. Currently supporting Facebook, Instagram, Twitter, Vimeo, Vine and YouTube.

Installation

Install the npm package:

npm install categorised-url.js

Import as a module:

// ES6 module
import CategorisedUrl from 'categorised-url.js';

// CommonJS
const CategorisedUrl = require('./categorised-url.js');

Or load the minified library:

<script type="text/javascript" src="<path-to-module>/dist/categorised-url.min.js"></script>

Usage

var urlMetadata = CategorisedUrl.fromUrl('https://www.youtube.com/watch?v=x8wC-WxC31s');

urlMetadata.provider // youtube
urlMetadata.resource_type // media
urlMetadata.resource // x8wC-WxC31s
urlMetadata.canonical_url // https://www.youtube.com/watch?v=x8wC-WxC31s

Meta Data

• url: Url provided
• provider: One of the providers above
• resource_type: User or Media
• resource: Resource ID (either media or user)
• canonical_url: Canonical URL for the resource

Running / Development

• git clone <repository-url> this repository
• cd categorized-url.js
• npm install