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

apileague-js

v1.6.3

Published

API League is a Hub for World Class APIs.

Downloads

18

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Maintainers

ddskyddsky

Keywords

Readme

apileague-js

ApileagueJs - JavaScript client for apileague-js API League is a Hub for World Class APIs. This SDK is automatically generated by the OpenAPI Generator project:

  • API version: 1.6.3
  • Package version: 1.6.3
  • Generator version: 7.8.0-SNAPSHOT
  • Build package: org.openapitools.codegen.languages.JavascriptClientCodegen

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install apileague-js --save

Finally, you need to build the module:

npm run build
Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

To use the link you just defined in your project, switch to the directory you want to use your apileague-js from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

Finally, you need to build the module:

npm run build

git

If the library is hosted at a git repository, e.g.https://github.com/ddsky/api-league-clients/tree/master/javascript/ then install it via:

    npm install ddsky/api-league-clients/tree/master/javascript/ --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var ApileagueJs = require('apileague-js');

var defaultClient = ApileagueJs.ApiClient.instance;
// Configure API key authorization: apiKey
var apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix['api-key'] = "Token"
// Configure API key authorization: headerApiKey
var headerApiKey = defaultClient.authentications['headerApiKey'];
headerApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//headerApiKey.apiKeyPrefix['x-api-key'] = "Token"

var api = new ApileagueJs.ArtApi()
var url = "https://upload.wikimedia.org/wikipedia/commons/3/35/Basic_human_drawing.png"; // {String} The URL to the image.
var opts = {
  'width': 200, // {Number} The maximum width of the image (default 400, max. 500).
  'height': 200 // {Number} The maximum height of the image (default 400, max. 500).
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.imageToAsciiArtByURL(url, opts, callback);

Documentation for API Endpoints

All URIs are relative to https://api.apileague.com

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- ApileagueJs.ArtApi | imageToAsciiArtByURL | GET /convert-image-to-ascii-txt | Image to Ascii Art by URL ApileagueJs.ArtApi | randomPoem | GET /retrieve-random-poem | Random Poem ApileagueJs.BooksApi | findSimilarBooks | GET /list-similar-books | Find Similar Books ApileagueJs.BooksApi | searchBooks | GET /search-books | Search Books ApileagueJs.FoodApi | computeNutrition | GET /compute-nutrition | Compute Nutrition ApileagueJs.FoodApi | retrieveRecipeInformation | GET /retrieve-recipe | Retrieve Recipe Information ApileagueJs.FoodApi | searchDrinks | GET /search-drinks | Search Drinks ApileagueJs.FoodApi | searchRecipes | GET /search-recipes | Search Recipes ApileagueJs.FoodApi | searchRestaurants | GET /search-restaurants | Search Restaurants ApileagueJs.HumorApi | generateNonsenseWord | GET /generate-nonsense-word | Generate Nonsense Word ApileagueJs.HumorApi | randomJoke | GET /retrieve-random-joke | Random Joke ApileagueJs.HumorApi | randomMeme | GET /retrieve-random-meme | Random Meme ApileagueJs.HumorApi | searchGifs | GET /search-gifs | Search Gifs ApileagueJs.HumorApi | searchJokes | GET /search-jokes | Search Jokes ApileagueJs.HumorApi | searchMemes | GET /search-memes | Search Memes ApileagueJs.KnowledgeApi | randomQuote | GET /retrieve-random-quote | Random Quote ApileagueJs.KnowledgeApi | randomRiddle | GET /retrieve-random-riddle | Random Riddle ApileagueJs.KnowledgeApi | randomTrivia | GET /retrieve-random-trivia | Random Trivia ApileagueJs.MathApi | convertUnits | GET /convert-units | Convert Units ApileagueJs.MediaApi | detectMainImageColor | GET /detect-color | Detect Main Image Color ApileagueJs.MediaApi | rescaleImage | GET /rescale-image | Rescale Image ApileagueJs.MediaApi | searchIcons | GET /search-icons | Search Icons ApileagueJs.MediaApi | searchRoyaltyFreeImages | GET /search-images | Search Royalty Free Images ApileagueJs.NewsApi | extractNews | GET /extract-news | Extract News ApileagueJs.NewsApi | searchNews | GET /search-news | Search News ApileagueJs.NewsApi | topNews | GET /retrieve-top-news | Top News ApileagueJs.StorageApi | readKeyValueFromStore | GET /read-key-value | Read Key Value from Store ApileagueJs.StorageApi | storeKeyValueGET | GET /store-key-value | Store Key Value (GET) ApileagueJs.TextApi | correctSpelling | GET /correct-spelling | Correct Spelling ApileagueJs.TextApi | detectGenderByName | GET /detect-gender | Detect Gender by Name ApileagueJs.TextApi | detectLanguage | GET /detect-language | Detect Language ApileagueJs.TextApi | detectSentiment | GET /detect-sentiment | Detect Sentiment ApileagueJs.TextApi | extractDates | GET /extract-dates | Extract Dates ApileagueJs.TextApi | extractEntities | GET /extract-entities | Extract Entities ApileagueJs.TextApi | listWordSynonyms | GET /list-synonyms | List Word Synonyms ApileagueJs.TextApi | pluralizeWord | GET /pluralize-word | Pluralize Word ApileagueJs.TextApi | scoreReadability | GET /score-readability | Score Readability ApileagueJs.TextApi | scoreText | GET /score-text | Score Text ApileagueJs.TextApi | singularizeWord | GET /singularize-word | Singularize Word ApileagueJs.TextApi | stemText | GET /stem-text | Stem Text ApileagueJs.TextApi | tagPartOfSpeech | GET /tag-pos | Tag Part of Speech ApileagueJs.WebApi | extractAuthors | GET /extract-authors | Extract Authors ApileagueJs.WebApi | extractContentFromAWebPage | GET /extract-content | Extract Content from a Web Page ApileagueJs.WebApi | extractPublishDate | GET /extract-publish-date | Extract Publish Date ApileagueJs.WebApi | retrievePageRank | GET /retrieve-page-rank | Retrieve Page Rank ApileagueJs.WebApi | searchWeb | GET /search-web | Search Web ApileagueJs.WebApi | verifyEmailAddress | GET /verify-email | Verify Email Address

Documentation for Models

Documentation for Authorization

Authentication schemes defined for the API:

apiKey

  • Type: API key
  • API key parameter name: api-key
  • Location: URL query string

headerApiKey

  • Type: API key
  • API key parameter name: x-api-key
  • Location: HTTP header