chainlist module for Nest framework (node.js)
⚠️ This package is still in the development stage, please do not use it in the production environment!!!
-
ChainsModule
import { ChainsModule } from 'nestjs-chainlist'; @Module({ imports: [ ChainsModule.forRootAsync({ isGlobal: true, useFactory: (configService: ConfigService) => { const data = configService.get('chains') as any[]; const lists = configService.get('chain_lists') as Record<string, number[]>; return { data, lists }; }, inject: [ConfigService], }), ] }) export class TestModule {}
-
ChainsService
Provide ChainsService to access all chain and list.
it was extends to Chains class, see chainlist for details.import { ChainsService } from 'nestjs-chainlist'; export class TestService { constructor( @Inject() private readonly chainsService: ChainsService, ){} }
-
@Chains() decorator
import { Chains } from 'nestjs-chainlist'; export class TestService { constructor( @Chains('list name') private readonly chainlist: ChainList, ){} }
-
Route params decorator
Extractchain_id
fromreq.query
:@Get('/') findOne(@QueryChain('chain_id') chain: Chain) {}
Extract
chainId
fromreq.body
:@Post('/') create(@BodyChain('chainIds') chains: Chain[]) {}
Extract
chainId
fromreq.params
:@Get('/') findOne(@ParamChain('chainId') chain: Chain) {}
Extract
x-chain-id
fromreq.headers
:@Get('/') findOne(@HeaderChain('x-chain-id') chain: Chain) {}
npm i nestjs-chainlist
or
yarn add nestjs-chainlist
Contributions are welcome! If you have any ideas, suggestions, or bug reports, please open an issue or submit a pull request. Make sure to read the contribution guidelines before getting started.
This project is licensed under the MIT License.