https://github.com/lbenie/yify-api

Yify torrent api service written in TypeScript
https://github.com/lbenie/yify-api

torrents typescript-library yify yify-movies yify-torrents

Last synced: 6 months ago
JSON representation

Yify torrent api service written in TypeScript

• Host: GitHub
• URL: https://github.com/lbenie/yify-api
• Owner: lbenie
• License: mit
• Created: 2019-10-09T00:51:26.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2024-12-03T03:29:26.000Z (7 months ago)
• Last Synced: 2024-12-03T04:23:26.570Z (7 months ago)
• Topics: torrents, typescript-library, yify, yify-movies, yify-torrents
• Language: TypeScript
• Homepage:
• Size: 3.54 MB
• Stars: 5
• Watchers: 3
• Forks: 0
• Open Issues: 20
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# yify-api

[![Build Status](https://travis-ci.org/lbenie/yify-api.svg?branch=master)](https://travis-ci.org/lbenie/yify-api)

[![codecov](https://codecov.io/gh/lbenie/yify-api/branch/master/graph/badge.svg)](https://codecov.io/gh/lbenie/yify-api)

[![Mutation testing badge](https://badge.stryker-mutator.io/github.com/lbenie/yify-api/master)](https://stryker-mutator.github.io)

[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/) 

![GitHub](https://img.shields.io/github/license/lbenie/yify-api)

![npm type definitions](https://img.shields.io/npm/types/yify-api)

![npm bundle size](https://img.shields.io/bundlephobia/minzip/yify-api)

![GitHub All Releases](https://img.shields.io/github/downloads/lbenie/yify-api/total)

![GitHub release (latest by date)](https://img.shields.io/github/v/release/lbenie/yify-api)

![npm](https://img.shields.io/npm/v/yify-api)

![npm](https://img.shields.io/npm/dm/yify-api)

![Snyk Vulnerabilities for npm package](https://img.shields.io/snyk/vulnerabilities/npm/yify-api)

This module is a JavaScript wrapper around the Yify Torrents api.

## TypeScript

This module is written in TypeScript and provides the typings.

## Usage

It works both on the web and node.

### module

```ts

import { YifyService } from 'yify-api'

// apiBaseUrl defaults to: https://yts.lt/api/v2/

const yifyService = new YifyService()

yifyService.getMovies().then(movies => {

  // movies

})

```

### commonjs

```ts

const yifyApi = require('yify-api')

const yifyService = new yifyApi.YifyService()

yifyService.getMovies().then(movies => {

  // movies

})

```