@remnawave/xtls-sdk
Version:
A Typescript SDK for XRAY (XTLS) Core GRPC Api
31 lines • 1.3 kB
TypeScript
import { Channel } from 'nice-grpc';
import { RoutingServiceClient } from '../xray-protos/app/router/command/command';
import { RemoveRuleByRuleTagResponseModel } from './models';
import { ISdkResponse } from '../common/types/sdk-response';
import { IRemoveRuleByRuleTag } from './interfaces';
/**
* Service for managing routing rules in XRAY/XTLS
* RoutingService is required (enable on XRay Config) to add/remove routing rules.
*/
export declare class RouterService {
private readonly channel;
private readonly client;
/**
* Creates an instance of RouterService
* @param channel - The gRPC channel to use for communication
*/
constructor(channel: Channel);
/**
* Removes a routing rule by its tag
* @param dto - Data transfer object containing rule tag
* @param dto.ruleTag - Tag of the rule to remove
* @returns Promise resolving to response indicating success or failure
*/
removeRuleByRuleTag(dto: IRemoveRuleByRuleTag): Promise<ISdkResponse<RemoveRuleByRuleTagResponseModel>>;
/**
* Gets the raw gRPC client for direct access to all routing service methods
* @returns The underlying RoutingServiceClient instance
*/
get rawClient(): RoutingServiceClient;
}
//# sourceMappingURL=router.service.d.ts.map