Kronos-Integration/kronos-service-manager-admin

View on GitHub
README.md

Summary

Maintainability
Test Coverage
[![npm](https://img.shields.io/npm/v/@kronos-integration/service-admin.svg)](https://www.npmjs.com/package/@kronos-integration/service-admin)
[![License](https://img.shields.io/badge/License-BSD%203--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause)
[![bundlejs](https://deno.bundlejs.com/?q=@kronos-integration/service-admin\&badge=detailed)](https://bundlejs.com/?q=@kronos-integration/service-admin)
[![downloads](http://img.shields.io/npm/dm/@kronos-integration/service-admin.svg?style=flat-square)](https://npmjs.org/package/@kronos-integration/service-admin)
[![GitHub Issues](https://img.shields.io/github/issues/Kronos-Integration/service-admin.svg?style=flat-square)](https://github.com/Kronos-Integration/service-admin/issues)
[![Build Status](https://img.shields.io/endpoint.svg?url=https%3A%2F%2Factions-badge.atrox.dev%2FKronos-Integration%2Fservice-admin%2Fbadge\&style=flat)](https://actions-badge.atrox.dev/Kronos-Integration/service-admin/goto)
[![Styled with prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg)](https://github.com/prettier/prettier)
[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)
[![Known Vulnerabilities](https://snyk.io/test/github/Kronos-Integration/service-admin/badge.svg)](https://snyk.io/test/github/Kronos-Integration/service-admin)
[![Coverage Status](https://coveralls.io/repos/Kronos-Integration/service-admin/badge.svg)](https://coveralls.io/github/Kronos-Integration/service-admin)

# kronos-service-admin

kronos server manager admin service

# API

<!-- Generated by documentation.js. Update this documentation by updating the source code. -->

### Table of Contents

*   [LiveProbeInterceptor](#liveprobeinterceptor)
    *   [name](#name)
*   [ServiceAdmin](#serviceadmin)
    *   [Parameters](#parameters)
    *   [requestProbe](#requestprobe)
        *   [Parameters](#parameters-1)
    *   [name](#name-1)

## LiveProbeInterceptor

**Extends Interceptor**

Sends request to the admin service.

### name

Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 'live-probe'

## ServiceAdmin

**Extends Service**

Kronos administration service.

### Parameters

*   `config` &#x20;
*   `ic` &#x20;

### requestProbe

Sends passing requst to all registerd endpoints.

#### Parameters

*   `endpoint` **Endpoint**&#x20;
*   `args` **any**&#x20;

### name

Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 'admin'

# install

With [npm](http://npmjs.org) do:

```shell
npm install kronos-service-admin
```

# license

BSD-2-Clause