2.0.6 • Published 4 years ago

bsapi.js v2.0.6

Weekly downloads
-
License
Apache-2.0
Repository
github
Last release
4 years ago

BS-API

An npm package that can interact with bs-api easily.

Install

npm install bsapi.js

Updates

Version v2.0.6

  • Bug Fixes
  • Fixed Tag Validator Regexp

Types

Request TypesDescription
getUses Get Method To Request Data
postUses Post Method To Request Data
wsUses WebSocket To Receive Data

Response TypeDescription
playerGet A Player's Game Stats
clubsGet A Club's Stats
rankings/playersTop Rankings ( Player )
rankings/clubsTop Rankings ( Club )
brawlersList Of Every Brawlers
eventsEvents Rotation
You can find the list of every response types at here

Usage

const bs = require('bsapi.js')

bs.<Request_Type>('<Type>','<TAG>').then(res => {

  // Handle Datas

}).catch(err => // Handle Errors )
  • Example Usage

    Get A Player's In-Game Profile Information

    bs.get('player','82PGQVJ2L').then(res => {
    console.log(res)
    }).catch(err => console.log(err))

    Get Current Event Rotation ( Async / Await )

    (async () => {
    console.log(await bs.get('events'));
    })();

    WebSocket To Get Battlelogs

    bs.ws({
    type: 'battlelog',
    tag: '82PGQVJ2L'
    }, (err, data) => {
     console.log(err, data)
    })

Tag Validator

This function allows you to validate a Brawl Stars Tag

const { validator } = require('bsapi.js')
// ... ( async )
await validator('<Type>', '<#TAG>')

supported types : club, player, brawlers

Or Use Regexp ( Only Validates Tag Pattern, Doesn't Tell If Its Exist )

const { regexp } = require('bsapi.js');
// Returns Boolean ( true / false )
regexp('<#TAG>')

supported types : club, player, map

CLI

Interact with bs-api through cli.

npm install -g bsapi.js

to use cli, you'll have to install this package globally

  • Usage


    To learn more about CLI options/commands, run the help command or -h (or --help) argument :

    $ bs help

License

Apache-2.0

2.0.6

4 years ago

2.0.3

4 years ago

2.0.5

4 years ago

2.0.4

4 years ago

2.0.1

4 years ago

2.0.0

4 years ago

1.0.9

4 years ago

1.0.8

4 years ago

1.0.7

4 years ago

1.0.6

4 years ago

1.0.5

4 years ago

1.0.4

4 years ago

1.0.3

4 years ago

1.0.2

4 years ago

1.0.1

4 years ago

1.0.0

4 years ago