bukget-clientdeprecated

Bukget API v3 Wrapper

Usage no npm install needed!

<script type="module">
  import bukgetClient from 'https://cdn.skypack.dev/bukget-client';
</script>

README

bukget.js

npm install bukget

bukget.js - Node.js Wrapper for the Bukget v3 API

Code Examples

   var bukget = require('bukget')({
      userAgent: 'my-custom-useragent' // usefull for stats on usage
   });
   
   bukget.getPlugin('worldguard', function(err, results){
      console.log(results);
   });
   
   bukget.basicSearch({
      field: 'slug',
      action: 'like',
      value: 'world',
      size: 5
   }, function(err, results){
      console.log(results);
   });

Documentation

Other than the method names differing from the routes all data and required fields match the Bukget v3 API.

Init Options

   var bukget = require('bukget')({
        url: 'api.bukget.org/',
        version: 3,
        https: false,
        rejectUnauthorizedSSL: false,
        userAgent: 'Bukget-node.js',
        localAddress : false,
        pluginServer: 'bukkit'
   });
  • url - string - url to make requests to. Useful when to change when using an internal bukget server
  • version - int - version number to prepend to each route request
  • https - boolean - Force HTTPS requests
  • rejectUnauthorizedSSL - boolean - Force requests to accept unauthorized SSL certificates
  • userAgent - string - useragent used to track usage.
  • localAddress - string - local address to bind to when making connections
  • pluginServer - string - which server binary to use plugins lookups for

Methods