@remnawave/xtls-sdk-nestjs/README.md

 

# NestJS XTLS SDK Module

![GitHub top language](https://img.shields.io/github/languages/top/remnawave/xtls-sdk-nestjs)
![GitHub Repo stars](https://img.shields.io/github/stars/remnawave/xtls-sdk-nestjs)

![npm version](https://img.shields.io/npm/v/@remnawave/xtls-sdk-nestjs)
![GitHub Tag](https://img.shields.io/github/v/tag/remnawave/xtls-sdk-nestjs)

![Build Status](https://img.shields.io/github/actions/workflow/status/remnawave/xtls-sdk-nestjs/.github/workflows/deploy-lib.yml)
![Downloads](https://img.shields.io/npm/dt/@remnawave/xtls-sdk-nestjs)
![License](https://img.shields.io/npm/l/@remnawave/xtls-sdk-nestjs)
![NPM Last Update](https://img.shields.io/npm/last-update/%40remnawave%2Fxtls-sdk-nestjs)

![Known Vulnerabilities](https://snyk.io/test/github/remnawave/xtls-sdk-nestjs/badge.svg)
![Coverage Status](https://img.shields.io/codecov/c/github/remnawave/xtls-sdk-nestjs)

A NestJS module wrapper for the XTLS SDK, providing seamless integration of XTLS functionality into your NestJS applications.

## Installation

```bash
npm install @remnawave/xtls-sdk-nestjs
```

## Features

- 🚀 Easy integration with NestJS applications
- ⚡ Supports both synchronous and asynchronous configuration
- 🔄 Automatic cleanup on application shutdown
- 🌐 Global module availability
- 🎯 Custom decorator for easy injection

## Quick Start

### Synchronous Configuration

```typescript
import { XtlsSdkNestjsModule } from '@remnawave/xtls-sdk-nestjs';

@Module({
  imports: [
    XtlsSdkNestjsModule.forRoot({
      ip: 'your-ip-address',
      port: 'your-port',
    }),
  ],
})
export class AppModule {}
```

### Asynchronous Configuration

```typescript
import { XtlsSdkNestjsModule } from '@remnawave/xtls-sdk-nestjs';

@Module({
  imports: [
    XtlsSdkNestjsModule.forRootAsync({
      imports: [ConfigModule],
      useFactory: async (configService: ConfigService) => ({
        ip: configService.get('XTLS_IP'),
        port: configService.get('XTLS_PORT'),
      }),
      inject: [ConfigService],
    }),
  ],
})
export class AppModule {}
```

## Usage in Services

Use the `@InjectXtls()` decorator to inject the XTLS SDK instance into your services:

```typescript
import { Injectable } from '@nestjs/common';
import { InjectXtls } from '@remnawave/xtls-sdk-nestjs';
import { XtlsApi } from '@remnawave/xtls-sdk';

@Injectable()
export class YourService {
  constructor(@InjectXtls() private readonly xtlsApi: XtlsApi) {}

  async yourMethod() {
    // Use xtlsApi here
  }
}
```

## Configuration Options

| Option | Type   | Description                             |
| ------ | ------ | --------------------------------------- |
| ip     | string | The IP address for the XTLS connection  |
| port   | string | The port number for the XTLS connection |

## API Reference

### XtlsSdkNestjsModule

- `forRoot(options: XtlsModuleOptions)`: Static method for synchronous module configuration
- `forRootAsync(options: AsyncModuleOptions)`: Static method for asynchronous module configuration

### Decorators

- `@InjectXtls()`: Decorator for injecting the XTLS SDK instance

## License

AGPL-3.0-only

## Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

## Support

For support, please open an issue in the GitHub repository.