@simpleapps-com/augur-api
Version:
TypeScript client library for Augur microservices API endpoints
43 lines • 1.45 kB
TypeScript
import type { NexusClient } from '../client';
type ExecuteRequest = NexusClient['executeRequest'];
/**
* Creates the ping resource methods
* OpenAPI Path: /ping → ping.*
* @description Simple ping endpoint for connectivity testing
*/
export declare function createPingResource(executeRequest: ExecuteRequest): {
/**
* Simple ping endpoint that doesn't require authentication
* @description Returns "pong" response for basic connectivity testing - OpenAPI path /ping
* @fullPath api.nexus.ping.get
* @service nexus
* @domain service-monitoring
* @discoverable true
* @dataMethod pingData.get
* @example
* ```typescript
* const pong = await client.ping.get();
* console.log(pong.data); // "pong"
* ```
*/
get: () => Promise<{
params: Record<string, unknown> | unknown[];
data: "pong";
options: Record<string, unknown> | unknown[];
status: number;
message: string;
count: number;
total: number;
totalResults: number;
}>;
};
/**
* Creates the pingData resource methods (data-only versions)
*/
export declare function createPingDataResource(ping: ReturnType<typeof createPingResource>): {
get: () => Promise<"pong">;
};
export type PingResource = ReturnType<typeof createPingResource>;
export type PingDataResource = ReturnType<typeof createPingDataResource>;
export {};
//# sourceMappingURL=ping.d.ts.map