zeldon/mineping
1
0
Fork 0
mirror of https://github.com/minescope/mineping.git synced 2024-12-25 19:05:46 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: added clarification regarding CommonJS

Browse Source
This commit is contained in:
Timofey Gelazoniya 2022-01-11 02:24:39 +03:00
parent f369fa14b9
commit 9ae6e7c89d
Signed by: zeldon
GPG Key ID: 047886915281DD2A
1 changed files with 20 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
README.md
View File

@ -14,12 +14,29 @@ Collect information about Minecraft (both Java and Bedrock) using **[Node.js](ht
npm i @minescope/mineping
```
## Example
## Loading and configuration the module
### ES Modules (ESM)
```js
import { pingJava, pingBedrock } from 'mineping';
```
### CommonJS
`mineping` is an ESM-only module - you are not able to import it with `require()`.
If you cannot switch to ESM, you can use the async `import()` function from CommonJS to load `mineping` asynchronously:
```js
const pingJava = (...args) => import('mineping').then(module => module.pingJava(...args));
const pingBedrock = (...args) => import('mineping').then(module => module.pingBedrock(...args));
```
## Usage
Ping a Java server with default options:
```js
import { pingJava } from 'mineping'
import { pingJava } from 'mineping';
const data = await pingJava('mc.hypixel.net');
console.log(data);
@ -28,7 +45,7 @@ console.log(data);
Ping a Bedrock server with custom options:
```js
import { pingBedrock } from 'mineping'
import { pingBedrock } from 'mineping';
const data = await pingBedrock('mco.mineplex.com', {
port: 19132,