itzg-docker-minecraft-bedrock-server

Namespace

itzg-docker-minecraft-bedrock-server

Description:
  • Unleash the full potential of multiplayer gaming with Itzg's Minecraft Bedrock Server Docker. Effortlessly run and upgrade your server with cutting-edge game features. Your world, your rules—simplified!

Author:

Methods

(async, static) createItzgDockerMinecraftBedrockServerInstance(context, body) → {ItzgDockerMinecraftBedrockServer}

Description:
  • Create a new Minecraft Server (Bedrock) instance

Example
import { Context } from '@osaas/client-core';
import { createItzgDockerMinecraftBedrockServerInstance } from '@osaas/client-services';

const ctx = new Context();
const body: ItzgDockerMinecraftBedrockServerConfig = { name: 'myinstance', ... };
const instance = await createItzgDockerMinecraftBedrockServerInstance(ctx, body);
console.log(instance.url);
Parameters:
Name Type Description
context Context

Open Source Cloud configuration context

body ItzgDockerMinecraftBedrockServerConfig

Service instance configuration

Returns:
  • Service instance
Type
ItzgDockerMinecraftBedrockServer

(async, static) getItzgDockerMinecraftBedrockServerInstance(context, name) → {ItzgDockerMinecraftBedrockServer}

Description:
  • Get a Minecraft Server (Bedrock) instance

Example
import { Context } from '@osaas/client-core';
import { getItzgDockerMinecraftBedrockServerInstance } from '@osaas/client-services';

const ctx = new Context();
const instance = await getItzgDockerMinecraftBedrockServerInstance(ctx, 'myinstance');
console.log(instance.url);
Parameters:
Name Type Description
context Context

Open Source Cloud configuration context

name string

Name of the bedrock-server to be retrieved

Returns:
  • Service instance
Type
ItzgDockerMinecraftBedrockServer

(async, static) removeItzgDockerMinecraftBedrockServerInstance(context, name)

Description:
  • Remove a Minecraft Server (Bedrock) instance

Parameters:
Name Type Description
context Context

Open Source Cloud configuration context

name string

Name of the bedrock-server to be removed