You can not select more than 25 topics
			Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
		
		
		
		
			
				
					52 lines
				
				1.7 KiB
			
		
		
			
		
	
	
					52 lines
				
				1.7 KiB
			| 
								 
											4 years ago
										 
									 | 
							
								# origin(al)
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								[](http://unshift.io)[](http://browsenpm.org/package/original)[](https://travis-ci.org/unshiftio/original)[](https://david-dm.org/unshiftio/original)[](https://coveralls.io/r/unshiftio/original?branch=master)[](http://webchat.freenode.net/?channels=unshift)
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								Original generates the origin URL for a given URL or URL object. In addition to
							 | 
						||
| 
								 | 
							
								that it also comes with a simple `same` function to check if two URL's have the
							 | 
						||
| 
								 | 
							
								same origin.
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								## Install
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								This module is browserify and node compatible and is therefor release in the npm
							 | 
						||
| 
								 | 
							
								registry and can be installed using:
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								```
							 | 
						||
| 
								 | 
							
								npm install --save original
							 | 
						||
| 
								 | 
							
								```
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								## Usage
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								In all the examples we assume that the module is loaded using:
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								```js
							 | 
						||
| 
								 | 
							
								'use strict';
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								var origin = require('original');
							 | 
						||
| 
								 | 
							
								```
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								To get the origin of a given URL simply call `origin` function with any given
							 | 
						||
| 
								 | 
							
								URL to get origin.
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								```js
							 | 
						||
| 
								 | 
							
								var o = origin('https://google.com/foo/bar?path');
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								// o = https://google.com
							 | 
						||
| 
								 | 
							
								```
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								To compare if two URL's share the same origin you can call the `same` method.
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								```js
							 | 
						||
| 
								 | 
							
								if (origin.same('https://google.com/foo', 'https://primus.io')) {
							 | 
						||
| 
								 | 
							
								  console.log('same');
							 | 
						||
| 
								 | 
							
								} else {
							 | 
						||
| 
								 | 
							
								  console.log('guess what, google.com and primus.io are not the same origin');
							 | 
						||
| 
								 | 
							
								}
							 | 
						||
| 
								 | 
							
								```
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								And that's it.
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								## License
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								MIT
							 |