# signal-plugin

> Simple Capacitor plugin to get the signal strength(LTE,WiFi,Acoustic).

Latest version **0.0.3** (published 2023-05-28) · MIT license · 0 weekly downloads

## Install

```sh
npm install signal-plugin
pnpm add signal-plugin
yarn add signal-plugin
bun add signal-plugin
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.3 |
| Published | 2023-05-28 |
| First published | 2023-05-28 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 37 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Luca Domeniconi |
| Maintainers | lucadome24 |
| Keywords | capacitor, plugin, native |

## Links

- npm: https://www.npmjs.com/package/signal-plugin
- Repository: https://github.com/AjejeBrazorfEU/SignalPlugin
- Homepage: https://github.com/AjejeBrazorfEU/SignalPlugin#readme
- Issues: https://github.com/AjejeBrazorfEU/SignalPlugin/issues
- npm.io page: https://npm.io/package/signal-plugin

## Dependencies (1)

- [@capacitor/cli](https://npm.io/package/@capacitor/cli.md) ^5.0.4

## Recent versions

- 0.0.3 (latest) — 2023-05-28
- 0.0.2 — 2023-05-28
- 0.0.1 — 2023-05-28

## README

# signal-plugin

Simple Capacitor plugin to get the signal strength(LTE,WiFi,Acoustic).

## Disclaimer

The plugin only works for Android and has not been completely tested, use it carefully!!

## Install

```bash
npm install signal-plugin
npx cap sync
```

## Example

The function getSignalInfo() return an object containing the value of the 3 measured signals:
- `WIFI`
- `LTE`
- `MICROPHONE`

```TypeScript
async getSignalInfo(){
    this.signalInfo = (await SignalPlugin.getSignalInfo()).value;
    console.log("WIFI: " + this.signalInfo.WIFI);
    console.log("LTE: " + this.signalInfo.LTE);
    console.log("MICROPHONE: " + this.signalInfo.MICROPHONE);
}
```

## API

<docgen-index>

* [`echo(...)`](#echo)
* [`getSignalInfo()`](#getsignalinfo)
* [`checkPermissions()`](#checkpermissions)
* [`requestPermissions()`](#requestpermissions)
* [Interfaces](#interfaces)
* [Type Aliases](#type-aliases)

</docgen-index>

<docgen-api>
<!--Update the source file JSDoc comments and rerun docgen to update the docs below-->

### echo(...)

```typescript
echo(options: { value: string; }) => Promise<{ value: string; }>
```

| Param         | Type                            |
| ------------- | ------------------------------- |
| **`options`** | <code>{ value: string; }</code> |

**Returns:** <code>Promise&lt;{ value: string; }&gt;</code>

--------------------


### getSignalInfo()

```typescript
getSignalInfo() => Promise<{ value: any; }>
```

**Returns:** <code>Promise&lt;{ value: any; }&gt;</code>

--------------------


### checkPermissions()

```typescript
checkPermissions() => Promise<PermissionStatus>
```

**Returns:** <code>Promise&lt;<a href="#permissionstatus">PermissionStatus</a>&gt;</code>

--------------------


### requestPermissions()

```typescript
requestPermissions() => Promise<PermissionStatus>
```

**Returns:** <code>Promise&lt;<a href="#permissionstatus">PermissionStatus</a>&gt;</code>

--------------------


### Interfaces


#### PermissionStatus

| Prop             | Type                                                        |
| ---------------- | ----------------------------------------------------------- |
| **`WIFI`**       | <code><a href="#permissionstate">PermissionState</a></code> |
| **`LTE`**        | <code><a href="#permissionstate">PermissionState</a></code> |
| **`MICROPHONE`** | <code><a href="#permissionstate">PermissionState</a></code> |


### Type Aliases


#### PermissionState

<code>'prompt' | 'prompt-with-rationale' | 'granted' | 'denied'</code>

</docgen-api>

---
_Source: https://npm.io/package/signal-plugin · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._