Skip to content

Latest commit

 

History

History
143 lines (100 loc) · 3.45 KB

README.md

File metadata and controls

143 lines (100 loc) · 3.45 KB
Raw

yeast.js

The yeast.js is a library that provides a simple way to access the M-Team API. You can use it to get the information of the user, the torrent, the forum, and so on.

We've also provided the cli command to help you get what you want in an advanced way. Please, click here for more information

Usage of yeast.js

Prerequisites

  • Node.js 19.x or later

Install

You can install the module via bun or pnpm and so on:

pnpm add yeast.js

Usage

ES Module

You can import the module in your project like this(Node.js or Typescript):

import Yeast from 'yeast.js';

// The https://test2.*.* is the default value of the url if you don't provide it.
const yeast = new Yeast({ key: 'YOUR KEY', url: '' });

try {
  const info = await yeast.member.base('$userId');
  await yeast.member.bindOTP(); // The unimplemented error will be thrown
  const seeds = await yeast.seed.search({ mode: 'adult' });
} catch (err) {
  console.error(err);
}
CommonJS
const Yeast = require('yeast.js');
const yeast = new Yeast({ key: 'YOUR KEY', url: '' });
try {
  const info = await yeast.member.base('$userId');
  await yeast.member.bindOTP(); // The unimplemented error will be thrown
} catch (err) {
  console.error(err);
}

Implemented APIs

  • Forum
  • Friend
  • Laboratory
  • Member
  • RSS
  • Seed
  • Seek
  • Subtitle
  • System
  • Tracker

Full API definitions: https://yeast.vercel.app

Unimplemented APIs

Important

The APIs below have not been implemented yet because the original documents from the official website are not clear enough.

The UnimplementedMethodError error will be thrown when you call them.

Member

  • yeast.member.bindOTP
  • yeast.member.unbindOTP
  • yeast.member.changeEmail
  • yeast.member.changeEmailSendCode
  • yeast.member.getSessionList
  • yeast.member.checkInviteCode
  • yeast.member.forgotPwd
  • yeast.member.forgetPwdTow
  • yeast.member.queryLoginHistory
  • yeast.member.register
  • yeast.member.revokeSession
  • yeast.member.sendEmailVerifyCode
  • yeast.member.sendLoginEmailVerifyCode
  • yeast.member.updateLastBrowse

System

  • yeast.system.top
  • yeast.system.getConf

Tracker

  • yeast.tracker.announce
  • yeast.tracker.scrape
  • yeast.tracker.queryHistory

Seek

  • yeast.seek.recovery

Forum

  • yeast.forum.forumDel
  • yeast.forum.forumDetail
  • yeast.forum.topicDel OR yeast.forum.topic.delete
  • yeast.forum.topicMod OR yeast.forum.topic.modify
  • yeast.forum.topicRedirectV2 OR yeast.forum.topic.redirect

Important

To comply with the regulations of the official website, There are some APIs which are not allowed to be accessed by third-party applications. If you use them (Unimplemented Methods with underline), you may be banned from the website.