nestjs-chronik
v0.1.1
Published
NestJS wrapper for chronik client
Downloads
67
Readme
About
This package is a simple wrapper around [chronik-client] for Nestjs(https://www.npmjs.com/package/chronik-client).
Installation
This package requires chronik-client
dependency to work.
yarn add chronik-client nestjs-chronik
Getting Started
The simplest way to use nestjs-chronik
is to use ChronikModule.forRoot
or ChronikModule.forRootAsync
import { Module } from '@nestjs-common';
import { ChronikModule } from 'nestjs-chronik';
@Module({
imports: [
ChronikModule.forRoot({
networks: {
xec: {
clientUrls: ['https://chronik.be.cash/xec'],
nodeUrls: ['https://chronik.be.cash/xec', 'chronik.pay2stay.com']
}
}
}),
],
// or async
ChronikModule.forRootAsync({
inject: [ConfigService],
useFactory: (config: ConfigService) => ({
host: config.get<string>('CHRONIK_URL') || 'https://chronik.be.cash',
networks: ['xec', 'xpi', 'xrg', 'bch']
networks: {
xec: {
clientUrls: [config.get<string>('CHRONIK_URL') || 'https://chronik.be.cash'],
nodeUrls: [config.get<string>('CHRONIK_URL'), 'chronik.pay2stay.com']
}
}
}),
}),
})
export class AppModule {}
use @InjectChronikClient() and @InjectChronikClientNode()
decorator in any injectables to get a ChronikClient and ChroniClientNode
client inside class
import { Injectable } from '@nestjs/common';
import { InjectChronikClient } from 'nestjs-chronik';
import { ChronikClient, ChroniClientNode } from 'chronik-client';
@Injectable()
export class TestService {
public constructor(
@InjectChronikClient('xec') private readonly chronikXec: ChronikClient,
@InjectChronikClientNode('xec')
private readonly chronikNodeXec: ChronikClientNode,
) {}
}
Author
** Vince Tran (Lixi)**
License
Licensed under the MIT License - see the LICENSE file for details.