An open API service indexing awesome lists of open source software.

https://github.com/tiagodanin/unsplash-source-node

Wrapper for the Unsplash Source API
https://github.com/tiagodanin/unsplash-source-node

node-module nodejs unsplash unsplash-source wrapper

Last synced: 11 months ago
JSON representation

Wrapper for the Unsplash Source API

Awesome Lists containing this project

README

          

# Unsplash Source Node [![Build Status](https://travis-ci.org/TiagoDanin/Unsplash-Source-Node.png?branch=master)](https://travis-ci.org/TiagoDanin/Unsplash-Source-Node)

[![NPM](https://nodei.co/npm/unsplash-source-node.png?downloads=true&downloadRank=true&stars=true)](https://nodei.co/npm/unsplash-source-node./)

Wrapper for the Unsplash Source API

# Use

## Ger redirectURL
Add the param `redirectURL: true`
Note: This function use Promise

```javascript
const unsplash = require('unsplash-source-node')
const url = await unsplash({random: true, redirectURL: true})
//Return string: https://images.unsplash.com/photo-1515349933451-b95498259b01?ixlib=rb-0.3.5&q=80&fm=jpg&crop=entropy&cs=tinysrgb&w=1080&fit=max&ixid=eyJhcHBfaWQiOjF9&s=0f1ac7e4ca80001ea0ec1c2ed6ce08db
```

## Basic

- Random all photos

```javascript
const unsplash = require('unsplash-source-node')
const url = unsplash({random: true})
//Return string: https://source.unsplash.com/random/
```

- Random from a specific user

```javascript
const unsplash = require('unsplash-source-node')
const url = unsplash({user: 'tiagodanin'})
//Return string: https://source.unsplash.com/user/tiagodanin/
```

- Random from a user’s likes

```javascript
const unsplash = require('unsplash-source-node')
const url = unsplash({user: 'tiagodanin', likes: true})
//Return string: https://source.unsplash.com/user/tiagoDanin/likes/
```

- Random from a collection

```javascript
const unsplash = require('unsplash-source-node')
const url = unsplash({collection: '190727', likes: true})
//Return string: https://source.unsplash.com/collection/190727/
```

- Fixed daily/weekly photo

```javascript
const unsplash = require('unsplash-source-node')
const urlDaily = unsplash({daily: true})
//Return string: https://source.unsplash.com/daily/
const urlWeekly = unsplash({weekly: true})
//Return string: https://source.unsplash.com/weekly/
```

- Random search term
```javascript
const unsplash = require('unsplash-source-node')
const url = unsplash({search: 'nature,water'})
//Return string: https://source.unsplash.com/?nature,water/
```

## Use with class

```javascript
const unsplash = require('unsplash-source-node')
let myUnsplash = new unsplash({user: 'tiagodanin'})
myUnsplash.likes = true
myUnsplash.width = 1200
myUnsplash.height = 600
const url = myUnsplash.get()
//Return string: https://source.unsplash.com/user/tiagodanin/likes/1200x600/
```

# Installation

This is a [Node.js](https://nodejs.org/) module available through the
[npm registry](https://www.npmjs.com/). It can be installed using the
[`npm`](https://docs.npmjs.com/getting-started/installing-npm-packages-locally) command line tools.

```sh
$ npm install unsplash-source-node
```

# Dependencies

- [request](https://ghub.io/request): Simplified HTTP request client.
- [request-promise-native](https://ghub.io/request-promise-native): The simplified HTTP request client 'request' with Promise support. Powered by native ES6 promises.

# License

MIT