From a926e8b339440e9cc21192fcc595978975718fcf Mon Sep 17 00:00:00 2001 From: Hardik Shingala <34568645+hdkshingala@users.noreply.github.com> Date: Tue, 30 Jan 2024 13:17:31 +0530 Subject: [PATCH] Fix JS docs (#3173) --- sdks/aperture-js/README.md | 50 ++++++++++++++++++++------------------ 1 file changed, 26 insertions(+), 24 deletions(-) diff --git a/sdks/aperture-js/README.md b/sdks/aperture-js/README.md index c6dd79f0d0..27d3f71db6 100644 --- a/sdks/aperture-js/README.md +++ b/sdks/aperture-js/README.md @@ -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 @@ -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)