![\"Nest](\"https://nestjs.com/img/logo_text.svg\"){kind=logo}
\n \n\n \n \n \n
NestJS SAP RFC Client
\n\n[](https://github.com/grupoboticario/nestjs-sap-rfc/blob/main/LICENSE)\n[](https://github.com/grupoboticario/nestjs-sap-rfc/actions/workflows/codeql-analysis.yml)\n[](https://github.com/grupoboticario/nestjs-sap-rfc/actions/workflows/sonar.yml)\n[](https://github.com/grupoboticario/nestjs-sap-rfc/actions/workflows/ci.yml)\n[](https://github.com/grupoboticario/nestjs-sap-rfc/actions/workflows/publish.yml)\n[](https://github.com/grupoboticario/nestjs-sap-rfc)\n[](https://github.com/SAP/node-rfc)\n[](https://github.com/semantic-release/semantic-release)\n[](https://commitizen.github.io/cz-cli/)\n[](https://github.com/prettier/prettier)\n[](https://conventionalcommits.org)\n[](https://sonarcloud.io/summary/new_code?id=b15648de-145e-4a88-87e7-b2a57e04eaeb)\n[](https://sonarcloud.io/summary/new_code?id=b15648de-145e-4a88-87e7-b2a57e04eaeb)\n[](https://sonarcloud.io/summary/new_code?id=b15648de-145e-4a88-87e7-b2a57e04eaeb)\n[](https://sonarcloud.io/summary/new_code?id=b15648de-145e-4a88-87e7-b2a57e04eaeb)\n[](https://sonarcloud.io/summary/new_code?id=b15648de-145e-4a88-87e7-b2a57e04eaeb)\n[](https://github.com/grupoboticario/nestjs-sap-rfc)\n[](https://www.npmjs.com/package/nestjs-sap-rfc)\n[](https://www.typescriptlang.org)\n[](https://www.npmjs.com/package/nestjs-sap-rfc)\n\n## 📚 Description\n\nNestJS SAP RFC Client, providing convenient ABAP business logic consumption from NestJS\n\n## 🛠️ Installation\n\n[SAP NWRFC SDK installation](https://github.com/SAP/node-rfc/blob/main/doc/installation.md#sap-nwrfc-sdk-installation)\n\n```bash\nnpm install nestjs-sap-rfc --save\n```\n\n## 🏃 Getting Started\n\nRegister `SapModule` module in app.module.ts\n\n[Connection Pool](https://github.com/SAP/node-rfc/blob/main/doc/usage.md#connection-pool)\n\n```ts\nimport { SapModule } from 'nestjs-sap-rfc';\nimport { Module } from '@nestjs/common';\n\n@Module({\n imports: [\n SapModule.createPool({\n isGlobal: true, // for global module\n name: 'service_name', // for multiple modules (OPTIONAL)\n connectionParameters: {\n /* see RfcConnectionParameters */\n },\n clientOptions: {\n /* see RfcClientOptions */\n },\n poolOptions: {\n /* see RfcPoolOptions */\n },\n }),\n ],\n})\nexport class AppModule {}\n```\n\n[Connection Pool](https://github.com/SAP/node-rfc/blob/main/doc/usage.md#connection-pool) (Async Module)\n\n```ts\nimport { SapModule } from 'nestjs-sap-rfc';\nimport { Module } from '@nestjs/common';\n\n@Module({\n imports: [\n SapModule.createPoolAsync({\n isGlobal: true, // for global module\n name: 'service_name', // for multiple modules (OPTIONAL)\n useFactory: () => {\n return {\n connectionParameters: {\n /* see RfcConnectionParameters */\n },\n clientOptions: {\n /* see RfcClientOptions */\n },\n poolOptions: {\n /* see RfcPoolOptions */\n },\n };\n },\n }),\n ],\n})\nexport class AppModule {}\n```\n\n[Connection Pool](https://github.com/SAP/node-rfc/blob/main/doc/usage.md#connection-pool) (Async Module + ConfigService)\n\n```ts\nimport { SapModule } from 'nestjs-sap-rfc';\nimport { Module } from '@nestjs/common';\nimport { ConfigService } from '@nestjs/config';\n\n@Module({\n imports: [\n SapModule.createPoolAsync({\n isGlobal: true, // for global module\n name: 'service_name', // for multiple modules (OPTIONAL)\n useFactory: (config: ConfigService) => {\n return {\n connectionParameters: {\n /* see RfcConnectionParameters */\n /* config.get(...) */\n },\n clientOptions: {\n /* see RfcClientOptions */\n /* config.get(...) */\n },\n poolOptions: {\n /* see RfcPoolOptions */\n /* config.get(...) */\n },\n };\n },\n inject: [ConfigService],\n }),\n ],\n})\nexport class AppModule {}\n```\n\n[Direct Client](https://github.com/SAP/node-rfc/blob/main/doc/usage.md#client)\n\n```ts\nimport { SapModule } from 'nestjs-sap-rfc';\nimport { Module } from '@nestjs/common';\n\n@Module({\n imports: [\n SapModule.createClient({\n isGlobal: true, // for global module\n name: 'service_name', // for multiple modules (OPTIONAL)\n connectionParameters: {\n /* see RfcConnectionParameters */\n },\n clientOptions: {\n /* see RfcClientOptions */\n },\n }),\n ],\n})\nexport class AppModule {}\n```\n\n[Direct Client](https://github.com/SAP/node-rfc/blob/main/doc/usage.md#client) (Async Module)\n\n```ts\nimport { SapModule } from 'nestjs-sap-rfc';\nimport { Module } from '@nestjs/common';\n\n@Module({\n imports: [\n SapModule.createClientAsync({\n isGlobal: true, // for global module\n name: 'service_name', // for multiple modules (OPTIONAL)\n useFactory: () => {\n return {\n connectionParameters: {\n /* see RfcConnectionParameters */\n },\n clientOptions: {\n /* see RfcClientOptions */\n },\n };\n },\n }),\n ],\n})\nexport class AppModule {}\n```\n\n[Direct Client](https://github.com/SAP/node-rfc/blob/main/doc/usage.md#client) (Async Module + ConfigService)\n\n```ts\nimport { SapModule } from 'nestjs-sap-rfc';\nimport { Module } from '@nestjs/common';\nimport { ConfigService } from '@nestjs/config';\n\n@Module({\n imports: [\n SapModule.createClientAsync({\n isGlobal: true, // for global module\n name: 'service_name', // for multiple modules (OPTIONAL)\n useFactory: (config: ConfigService) => {\n return {\n connectionParameters: {\n /* see RfcConnectionParameters */\n },\n clientOptions: {\n /* see RfcClientOptions */\n },\n };\n },\n inject: [ConfigService],\n }),\n ],\n})\nexport class AppModule {}\n```\n\nInject SapService\n\n```ts\nimport { InjectSapService, SapService, SapRfcObject, SapRfcStructure } from 'nestjs-sap-rfc';\nimport { Injectable } from '@nestjs/common';\n\n// RfcStructure\ntype PositionData = SapRfcStructure; // SAP structure\n\n// RfcStructure\ninterface NestedData extends SapRfcStructure {\n readonly E_NESTED?: string; // SAP field name\n}\n\n// MySapInterface\ninterface MySapInterface extends SapRfcObject {\n readonly E_NAME?: string; // SAP field name\n readonly E_DATA?: PositionData; // SAP field name\n readonly E_DATA2?: NestedData; // SAP field name\n readonly E_ERROR?: string; // SAP field name\n readonly I_OBJID?: string; // SAP field name\n}\n\n@Injectable()\nexport class MyService {\n /**\n * @param {SapService} sapService\n */\n constructor(\n @InjectSapService()\n private readonly sapService: SapService,\n ) {}\n\n public async test(): MySapInterface {\n return this.sapService.execute