Skip to content

Commit

Permalink
Fix JS docs (#3173)
Browse files Browse the repository at this point in the history
  • Loading branch information
hdkshingala authored Jan 30, 2024
1 parent d4ed583 commit a926e8b
Showing 1 changed file with 26 additions and 24 deletions.
50 changes: 26 additions & 24 deletions sdks/aperture-js/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,30 +22,6 @@ code.
Refer [documentation](https://docs.fluxninja.com/sdk/javascript/) for more
details.

# API Reference

# @fluxninja/aperture-js

## Table of contents

### Enumerations

- [FlowStatus](docs/enums/FlowStatus.md)
- [LookupStatus](docs/enums/LookupStatus.md)

### Classes

- [ApertureClient](docs/classes/ApertureClient.md)

### Interfaces

- [CacheEntry](docs/interfaces/CacheEntry.md)
- [Flow](docs/interfaces/Flow.md)
- [FlowParams](docs/interfaces/FlowParams.md)
- [KeyDeleteResponse](docs/interfaces/KeyDeleteResponse.md)
- [KeyLookupResponse](docs/interfaces/KeyLookupResponse.md)
- [KeyUpsertResponse](docs/interfaces/KeyUpsertResponse.md)

## Usage

### Install SDK
Expand Down Expand Up @@ -119,3 +95,29 @@ that would provide granular visibility for each flow.

For more context on using the Aperture JavaScript SDK to set feature control
points, refer to the [example app][example] available in the repository.

[example]: https://github.com/fluxninja/aperture-js/tree/main/example

# API Reference

# @fluxninja/aperture-js

## Table of contents

### Enumerations

- [FlowStatus](docs/enums/FlowStatus.md)
- [LookupStatus](docs/enums/LookupStatus.md)

### Classes

- [ApertureClient](docs/classes/ApertureClient.md)

### Interfaces

- [CacheEntry](docs/interfaces/CacheEntry.md)
- [Flow](docs/interfaces/Flow.md)
- [FlowParams](docs/interfaces/FlowParams.md)
- [KeyDeleteResponse](docs/interfaces/KeyDeleteResponse.md)
- [KeyLookupResponse](docs/interfaces/KeyLookupResponse.md)
- [KeyUpsertResponse](docs/interfaces/KeyUpsertResponse.md)

0 comments on commit a926e8b

Please sign in to comment.