docs(docs): сhanged the module name according to the scope, added links to src files
This commit is contained in:
parent
24a4880230
commit
1249fa7632
|
@ -28,7 +28,7 @@ export type BedrockPingResponse = {
|
||||||
* @param host The Bedrock server address.
|
* @param host The Bedrock server address.
|
||||||
*
|
*
|
||||||
* ```js
|
* ```js
|
||||||
* import { pingBedrock } from 'mineping';
|
* import { pingBedrock } from '@minescope/mineping';
|
||||||
*
|
*
|
||||||
* const data = await pingBedrock('mco.mineplex.com');
|
* const data = await pingBedrock('mco.mineplex.com');
|
||||||
* console.log(data);
|
* console.log(data);
|
||||||
|
@ -43,6 +43,7 @@ export type BedrockPingResponse = {
|
||||||
* gamemode: 'Survival'
|
* gamemode: 'Survival'
|
||||||
* }
|
* }
|
||||||
* ```
|
* ```
|
||||||
|
* @see [source](https://github.com/minescope/mineping/blob/24a48802300f988d3ae520edbeb4f3e12820dcc9/lib/java.js#L117)
|
||||||
*/
|
*/
|
||||||
export function pingBedrock(host: string, options?: PingOptions): Promise<BedrockPingResponse>;
|
export function pingBedrock(host: string, options?: PingOptions): Promise<BedrockPingResponse>;
|
||||||
|
|
||||||
|
|
|
@ -32,7 +32,7 @@ export type JavaPingResponse = {
|
||||||
* @param options The configuration for pinging Minecraft Java server.
|
* @param options The configuration for pinging Minecraft Java server.
|
||||||
*
|
*
|
||||||
* ```js
|
* ```js
|
||||||
* import { pingJava } from 'mineping';
|
* import { pingJava } from '@minescope/mineping';
|
||||||
*
|
*
|
||||||
* const data = await pingJava('mc.hypixel.net');
|
* const data = await pingJava('mc.hypixel.net');
|
||||||
* console.log(data);
|
* console.log(data);
|
||||||
|
@ -48,6 +48,7 @@ export type JavaPingResponse = {
|
||||||
* favicon: 'data:image/png;base64,iVBORw0KGg...
|
* favicon: 'data:image/png;base64,iVBORw0KGg...
|
||||||
}
|
}
|
||||||
* ```
|
* ```
|
||||||
|
* @see [source](https://github.com/minescope/mineping/blob/8c84925ef7f5c420a7ef52740cba027491e82934/lib/bedrock.js#L158)
|
||||||
*/
|
*/
|
||||||
export function pingJava(host: string, options?: PingOptions): Promise<JavaPingResponse>;
|
export function pingJava(host: string, options?: PingOptions): Promise<JavaPingResponse>;
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue