Merge pull request #116 from KenEucker/develop

2.0.3

README.md

@@ -1,5 +1,5 @@
 <h1 align="center" style="border-bottom: none;">imgur</h1>
-<h3 align="center">Unofficial JavaScript library</h3>
+<h3 align="center">Unofficial JavaScript library for the Imgur.com API</h3>
 <p align="center">
  <a href="https://www.npmjs.com/package/imgur">
  <img alt="npm version" src="https://img.shields.io/npm/v/imgur/latest.svg">
@@ -44,11 +44,11 @@ const client = new ImgurClient({ accessToken: process.env.ACCESS_TOKEN });
 // or your client ID
 const client = new ImgurClient({ clientId: process.env.CLIENT_ID });
 
-// or your username/password/client id to retrieve an access token automatically:
+// all credentials with a refresh token, in order to get access tokens automatically
 const client = new ImgurClient({
- username: process.env.USERNAME,
- password: process.env.PASSWORD,
  clientId: process.env.CLIENT_ID,
+ clientSecret: process.env.CLIENT_SECRET,
+ refreshToken: process.env.REFRESH_TOKEN,
 });
 ```
 
@@ -62,39 +62,37 @@ If you don't have any credentials, you'll need to:
 ### Upload one or more images and videos
 
 ```ts
-// multiple images via an array of absolute paths
-const responses = await client.upload([
- '/home/kai/dank-meme.jpg',
- '/home/kai/another-dank-meme',
-]);
-responses.forEach((r) => console.log(r.link));
-```
-
-If you want to provide metadata, such as a title, description, etc., then pass an object instead of a string:
-
-```ts
-// multiple images via an array of absolute paths
-const responses = await client.upload([
+// upload multiple images via fs.createReadStream (node)
+const response = await client.upload([
  {
  image: createReadStream('/home/kai/dank-meme.jpg'),
- title: 'Meme',
- description: 'Dank Meme',
+ type: 'stream',
  },
  {
- image: createReadStream('/home/kai/cat.mp4'),
- title: 'A Cat Movie',
- description: 'Caturday',
+ image: createReadStream('/home/kai/another-dank-meme'),
+ type: 'stream',
  },
 ]);
-responses.forEach((r) => console.log(r.link));
+response.data.forEach((r) => console.log(r.link));
+```
+
+If you want to provide metadata, such as a title, description, etc., then pass an object instead of a string:
+
+```ts
+// upload image via url
+const response = await client.upload({
+ image: 'https://i.imgur.com/someImageHash',
+ title: 'Meme',
+ description: 'Dank Meme',
+});
+console.log(response.data);
 ```
 
 Acceptable key/values match what [the Imgur API expects](https://apidocs.imgur.com/#c85c9dfc-7487-4de2-9ecd-66f727cf3139):
 
 | Key | Description |
 | --------------- | ----------------------------------------------------------------------------------------------------------------------------------- |
-| `image` | A string that is a URL pointing to a remote image (up to 10MB) |
-| `base64` | A base 64 object that is to be placed in the the upload form |
+| `image` | A string, stream, or buffer that is a URL pointing to a remote image or video (up to 10MB) |
 | `album` | The id of the album you want to add the media to. For anonymous albums, album should be the deletehash that is returned at creation |
 | `type` | The type of the media that's being transmitted; `stream`, `base64` or `url` |
 | `name` | The name of the media. This is automatically detected, but you can override |

example/index.js

@@ -11,6 +11,7 @@ const imgur = new ImgurClient({
  accessToken: process.env.ACCESS_TOKEN,
  clientSecret: process.env.CLIENT_SECRET,
  clientId: process.env.CLIENT_ID,
+ rapidApiKey: process.env.RAPID_API_KEY,
 });
 
 const run = async (client) => {

package.json

@@ -2,7 +2,7 @@
  "author": "Ken Eucker <[email protected]>",
  "name": "imgur",
  "description": "Unofficial JavaScript library for Imgur",
- "version": "2.0.1",
+ "version": "2.0.3",
  "homepage": "https://github.com/keneucker/imgur",
  "license": "MIT",
  "keywords": [
@@ -19,7 +19,7 @@
  "form-data": "^4.0.0"
  },
  "engines": {
- "node": ">=16"
+ "node": ">=14"
  },
  "main": "imgur.node.js",
  "browser": "imgur.js",
@@ -70,11 +70,11 @@
  "commitizen": "^4.2.4",
  "cz-conventional-changelog": "^3.3.0",
  "dotenv": "^10.0.0",
- "eslint": "^8.5.0",
+ "eslint": "^8.6.0",
  "eslint-config-prettier": "^8.3.0",
  "husky": "^7.0.4",
  "jest": "^27.4.5",
- "lint-staged": "^12.1.4",
+ "lint-staged": "^12.1.5",
  "mock-fs": "^5.1.2",
  "msw": "^0.36.3",
  "node-polyfill-webpack-plugin": "^1.1.4",