birme-captcha-svc

Namespace

birme-captcha-svc

Description:

  • Enhance your security effortlessly with our reliable CAPTCHA Service! Easily generate and verify CAPTCHAs to protect against automated attacks. Quick setup, seamless integration, robust solution!

Author:
Copyright:
  • 2025 Eyevinn Technology AB

Methods

(async, static) createBirmeCaptchaSvcInstance(context, body) → {BirmeCaptchaSvc}

Description:

  • Create a new Captcha Service instance

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

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

Open Source Cloud configuration context
body BirmeCaptchaSvcConfig

Service instance configuration
Returns:
  • Service instance
Type
BirmeCaptchaSvc

(async, static) getBirmeCaptchaSvcInstance(context, name) → {BirmeCaptchaSvc}

Description:

  • Get a Captcha Service instance

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

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

Open Source Cloud configuration context
name string

Name of the service to be retrieved
Returns:
  • Service instance
Type
BirmeCaptchaSvc

(async, static) removeBirmeCaptchaSvcInstance(context, name)

Description:

  • Remove a Captcha Service instance

Parameters:
Name Type Description
context Context

Open Source Cloud configuration context
name string

Name of the service to be removed