matthamil / gfycat Goto Github PK

View Code? Open in Web Editor NEW

2.0 1.0 0.0 5.48 MB

Node JavaScript API wrapper written in TypeScript for Gfycat.com API

License: MIT License

JavaScript 2.15% TypeScript 97.85%

gfycat gfycatapi gfycatsdk nodejs

gfycat's Introduction

⚠️ This package is deprecated.

Gfycat is shutting down on September 1, 2023.

gfycat

Unofficial Node JavaScript API wrapper written in TypeScript for Gfycat.com API. Why an unofficial SDK? The official Gfycat JavaScript client is incomplete and lacks TypeScript support.

Install
Usage
Features
Contributing

Install

This package requires Node version 14 or higher.

Install with npm

npm i gfycat

or yarn

yarn add gfycat

Usage

See examples in the examples directory.

You will need a Gfycat API client id and client secret. Follow the steps in the Gfycat API documentation to obtain a client id and client secret.

You can enable logging by setting the DEBUG environment variable to gfycat, i.e. DEBUG=gfycat or DEBUG=*.

Features

This is a work-in-progress SDK. Not all APIs are implemented. The list of documented Gfycat API endpoints can be found in the Gfycat API documentation.

Authentication

Client Credentials Grant (currently, the GfycatClient only uses password grant authentication)
Password Grant Authentication
Refreshing access token
Checking if username is available / exists / is valid
Checking if your user's email is verified or not
Send verification email
Send a password reset email

Users

User Feeds

Collections

The collections APIs are undocumented.

Gfycat

Trending Feeds

Search

Contributing

This project uses commitizen and semantic-release. When committing, please use npm run commit to let commitizen create your commit.

gfycat's People

Contributors

Stargazers

Watchers

gfycat's Issues

Remove DEBUG package and allow consumers to provide their own logger

Allow GfycatClient to accept an optional log method similar to:

type Log = (response: { statusCode: number, body?: any }) => void | Promise<void>;

and add a static method log to the GfycatClient that allows consumers to enable the default logger

const client = new GfycatClient({
   ...opts,
   log: GfycatClient.log,
})