Coder Social home page Coder Social logo

pubg-sdk's Introduction

Advanced PUBG SDK

Robust wrapper for the official PUBG Developer API using

Key Features

  • Can be called via constructors or statically
  • Supports async/await
  • All calls return promise
  • Easy set up/usage

Installing

`npm i --s apubg-sdk

Usage

ApiKey/Region Environment Variables

Currently the api key and active region are fetched from environment variables, these are as follows:

  • apiKey - PUBG Developer Key
  • region - Region

These can be provided either directly to the environment, or via a .env file

Static calls

The sdk can be used via static calls to the imported classes, like so:

import {Player} from 'apubg-sdk'

// async/await
const shroud = await Player.get('account.d50fdc18fcad49c691d38466bed6f8fd')

//promise
Player.get('account.d50fdc18fcad49c691d38466bed6f8fd')
    .then(shroud => {
        // successful
    })
    .catch(exception => {
        // failed, failure response here
    })

Constructor calls

Or you can just new it up like so

const shroud = await new Player('account.d50fdc18fcad49c691d38466bed6f8fd')

Player.get('account.d50fdc18fcad49c691d38466bed6f8fd')
    .then(shroud => {
        // successful
    })
    .catch(exception => {
        // failed, failure response here
    })

pubg-sdk's People

Contributors

paulendri avatar

Watchers

James Cloos avatar Julio Diniz avatar  avatar

Forkers

mikahanninen

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.