npm package: @ramcna/capacitor-ephemeris
Description: Capacitor plugin that integrates Swiss Ephemeris (JNI) to calculate accurate planetary positions using SEPLM, SEPL_18, and SE1 ephemeris data files.
Author: Ram Ch
Latest version: 0.0.4

# @ramcna/capacitor-ephemeris

Capacitor plugin that integrates Swiss Ephemeris (JNI) to calculate accurate planetary positions using SEPLM, SEPL_18, and SE1 ephemeris data files.

## Install

```bash
npm install @ramcna/capacitor-ephemeris
npx cap sync
```

## API

<docgen-index>

* [`initialize(...)`](#initialize)
* [`calculateHoroscope(...)`](#calculatehoroscope)
* [`calculateAstroDetails(...)`](#calculateastrodetails)
* [`getAscendant(...)`](#getascendant)
* [`getCusps(...)`](#getcusps)
* [`getSMLSubPositions(...)`](#getsmlsubpositions)
* [Interfaces](#interfaces)

</docgen-index>

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

### initialize(...)

```typescript
initialize(options: InitializeOptions) => Promise<void>
```

| Param         | Type                                                            |
| ------------- | --------------------------------------------------------------- |
| **`options`** | <code><a href="#initializeoptions">InitializeOptions</a></code> |

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


### calculateHoroscope(...)

```typescript
calculateHoroscope(options: { context: string; }) => Promise<{ result: string; }>
```

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

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

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


### calculateAstroDetails(...)

```typescript
calculateAstroDetails(options: { jdUtc: number; context: string; }) => Promise<{ result: string; }>
```

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

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

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


### getAscendant(...)

```typescript
getAscendant(options: { context: string; }) => Promise<{ ascendant: number; }>
```

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

**Returns:** <code>Promise&lt;{ ascendant: number; }&gt;</code>

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


### getCusps(...)

```typescript
getCusps(options: { context: string; }) => Promise<{ cusps: number[]; }>
```

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

**Returns:** <code>Promise&lt;{ cusps: number[]; }&gt;</code>

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


### getSMLSubPositions(...)

```typescript
getSMLSubPositions(options: { context: string; }) => Promise<{ result: string; }>
```

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

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

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


### Interfaces


#### InitializeOptions

| Prop               | Type                | Description                                                                                                                                                                       |
| ------------------ | ------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **`ephPath`**      | <code>string</code> | Local path to ephemeris files on device                                                                                                                                           |
| **`ephemerisUrl`** | <code>string</code> | GitHub repository URL to ephemeris files Plugin will download all SE1 files from the repository's main branch Use raw GitHub URL or repository URL ending with 'main' or 'master' |

</docgen-api>