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

bds-lor-api-sdk

v1.0.2

Published

Take home project - The Lord of the Rings SDK

Downloads

2

Readme

The One API SDK Wrapper

This SDK wrapper provides access to "The One API" https://the-one-api.dev/.

The class includes three methods:

  • getMovies: Retrieve all movies from The One API.
  • getMovieById: Retrieve a movie with the specified ID from The One API.
  • getMovieQuotesById: Retrieve all quotes for a movie with the specified ID from The One API.

You can easily use this SDK in your Node.js project by creating a new instance of the TheOneApi class and calling its methods.

Getting Started

Prerequisites

To use this SDK, you will need:

  • An API key from The One API. You can sign up for an API key at https://the-one-api.dev/sign-up.
  • Node.js installed on your machine.

Installation

  1. Clone this repository: git clone https://github.com/your-username/the-one-api-sdk.git
  2. Install the dependencies: npm install

To install dotenv, axios and jest separately, you can run the following commands:

  • npm install axios
  • npm install jest --save-dev
  • npm install dotenv

Usage

Replace 'YOUR_API_KEY' with your actual API key. This example code creates a new instance of the TheOneApi class, calls its methods to retrieve information from The One API, and logs the results to the console.

const TheOneApi = require('bds-lor-api-sdk');

const apiKey = 'YOUR_API_KEY';
const api = new TheOneApi(apiKey);

async function main() {
  
  const movies = await api.lorMoviesGet();
  console.log('lorMoviesGet(): ', movies);

  const movieId = '5cd95395de30eff6ebccde5c';
  const movie = await api.lorMovieByIdGet(movieId);
  console.log(`lorMoviesGet(${movieId}): `, movie);

  const movieQuotes = await api.lorMovieQuotesByIdGet(movieId);
  console.log(`lorMovieQuotesByIdGet(${movieId}):`, movieQuotes);

}

main();

Testing

Test cases for the SDK functions are written in Jest and can be found in the /tests directory. Currently, only positive tests are included.

To run the tests, use the command npm test.

Version History

| Version | Author | Date | Details | | ------- | --------------| ---------- | --------------- | | 0.1 | Barry Solomon | 3/10/2023 | Initial Version |