bgm-sdk-inversify

A typescript sdk for bgm.tv API. for API reference, see: https://bangumi.github.io/api/

To use this SDK, you need to use with RxJS 6+ and Inversify.

Install

npm install @irohalab/bgm-sdk-inversify --save

Optionally, install dependencies

npm install inversify reflect-metadata rxjs typescript --save,

Usage

You need implement IAPIConfiguration and bind it to IAPIConfiguration serviceIdentifier If you decide to use HttpClient from this SDK to bind IApiHttpClient, you also need to install whatwg-fetch package.

import { DefaultService, DefaultServiceInterface, ApiServiceBinder } from '@irohalab/bgm-sdk-inversify';
import { injectable } from 'inversify';
import { Subject } from './subject';
import { lastValueFrom } from 'rxjs';
import IHttpClient from './IHttpClient';

const TYPES = {
    DefaultService: 'DefaultService'
}

@injectable()
export class YourInjectableService {
    constructor(@inject(TYPES.DefaultService) private _bgmClient: DefaultService) {
    }

    async getSubject(bgmId: number): Promise<Subject> {
        return await lastValueFrom(this._bgmClient.getSujectById(bgmId));
    }
}

const container = new Container();
container.bind<IAPIConfiguration>('IAPIConfiguration').to(YourAPIConfiguartion);
// there is a default implement of IHttpClient in the sdk. you can bind this
container.bind<IHttpClient>('IApiHttpClient').to(HttpClient);
ApiServiceBinder.with(container);
container.bind<YourInjectableService>(YourInjectableService).to(ApiServiceBinder);
const yourService = container.get<YourInjectableService>(YourInjectableService);
const subject = await yourService.getSubject(324295);