npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

fqapi-ts-tst

v0.1.35

Published

`flotiq-api-ts` is a package that installs a personalized SDK for Flotiq based on `flotiq-codegen-ts`. This package includes all the necessary TypeScript bindings to interact with the Flotiq API directly from your project.

Downloads

240

Readme

Flotiq API TypeScript SDK

flotiq-api-ts is a package that installs a personalized SDK for Flotiq based on flotiq-codegen-ts. This package includes all the necessary TypeScript bindings to interact with the Flotiq API directly from your project.

For more details on the underlying SDK, visit the repository: flotiq-codegen-ts.

Requirements

In order to install and use this package, the project must have an environment variable defined for the Flotiq API key. This can be provided in one of the following ways:

  • Define FLOTIQ_API_KEY in a .env or .env.local file in the project root.
  • Set the FLOTIQ_API_KEY environment variable in your system.

The API key is necessary for installing SDK package related to your Content Type Definitions in Flotiq.

Installation

To install the package, run the following command in your project:

yarn add flotiq-api-ts

Usage

Once installed, you can import and use the FlotiqApi to interact with the Flotiq API:

import { FlotiqApi } from "flotiq-api-ts";

// Example of usage
const flotiq = new FlotiqApi();

Make sure that you have your FLOTIQ_API_KEY correctly set before making any requests.

Development

To develop package, install dependencies and run yarn install

  1. Create .env file with FLOTIQ_API_KEY=__YOUR_FLOTIQ_API_KEY__
  2. Run npm install command, this will fire postinstall script
  3. In root directory there is ./flotiqApi sdk

Publishing

Run:

npm login
npm publish