Connection packages to connect to blitz.js API nodes. Choose your target platform from the available branches.

Installation

npm install blitz-js-query

Other Supported Platforms

| Platform | Install | Description | |:------------- |:------------- |:------------- | | python | pip | For usage in Python. Official Socket.io version updates are slow, HTTP might have to be explicitly enabled |

Usage

const Blitz = require("blitz-js-query")
const blitz = new Blitz()

blitz.get("/foo").then(res => console.log(res.body)) // bar

Configuration

const Blitz = require("blitz-js-query")
const blitz = new Blitz({key: value})

| Key | Default | Description | |:------------- |:------------- |:------------- | | api_url | "http://localhost:3010/" | URL of blitz.js API-Node to connect to | | auth_url | "http://localhost:3030/" | URL of blitz.js Auth-Node to authenticate with | | namespace | "/" | Socket.io namespace to connect to | | user_key | null | User key obtained via Auth-Node registration | | user_secret | null | User secret obtained via Auth-Node | | ignore_limiter | false | Whether or not to disable the default rate limit adaptions. Disabling this only makes sense if you connect as a user who won't face rate limits. If you disable it anyway, expect all your requests to get blocked. |

API

RESTful methods

blitz.get(url)

Sends a GET request to the API-Node

| Argument | Description | Default | |:------------- |:------------- |:------------- | | url | URL to request, without domain. e.g. /foo. | None |

blitz.post(url, body)

Sends a POST request to the API-Node

| Argument | Description | Default | |:------------- |:------------- |:------------- | | url | URL to request, without domain. e.g. /foo. | None | | body | Data to send to endpoint. Can be any data type. | None |

blitz.put(url, body)

Sends a PUT request to the API-Node

| Argument | Description | Default | |:------------- |:------------- |:------------- | | url | URL to request, without domain. e.g. /foo. | None | | body | Data to send to endpoint. Can be any data type. | None |

blitz.patch(url, body)

Sends a PATCH request to the API-Node

| Argument | Description | Default | |:------------- |:------------- |:------------- | | url | URL to request, without domain. e.g. /foo. | None | | body | Data to send to endpoint. Can be any data type. | None |

blitz.delete(url, body)

Sends a DELETE request to the API-Node

| Argument | Description | Default | |:------------- |:------------- |:------------- | | url | URL to request, without domain. e.g. /foo. | None | | body | Data to send to endpoint. Can be any data type. | None |

Socket.io

blitz.subscribe(endpoint)

Subscribe to updates on a specific endpoint. Updates can be listened to via blitz.on(endpoint, fn).

| Argument | Description | Default | |:------------- |:------------- |:------------- | | endpoint | URL to listen for updates on, without domain. e.g. /foo | None |

blitz.on(ev, fn)

Listens to specific Socket.io event, then runs the given function with the received data

| Argument | Description | Default | |:------------- |:------------- |:------------- | | ev | Event name. | None | | fn | Function to execute on event trigger | None |

blitz.emit(ev, data)

Emits event via Socket.io client to server

| Argument | Description | Default | |:------------- |:------------- |:------------- | | ev | Event name. | None | | data | Data to transmit. Can be any data type. | None |

License

MIT