Context

Overview

Module

• package: @aerokit/sdk/core
• source: core/context.ts
• last updated:

The Context API provides a simple, static interface for storing and retrieving key-value pairs in a global application context. It allows components and modules to share data across the entire application without needing to pass values through function parameters or component props. The Context API is designed to be lightweight and easy to use, making it ideal for managing global state, configuration settings, or any other data that needs to be accessible throughout the application.

Key Features

• Global Accessibility: Values stored in the context can be accessed from anywhere in the application, facilitating data sharing across components and modules.
• Simple API: The Context API provides straightforward get and set methods for managing context values, making it easy to use without complex setup.
• Dynamic Storage: The context can store any type of value, including primitives, objects, arrays, and even functions, allowing for flexible data management.
• Overwriting Values: Setting a value with an existing name will overwrite the previous value, enabling dynamic updates to the context as needed.

Use Cases

• Managing global configuration settings that need to be accessed by multiple components or modules.
• Sharing state or data across different parts of the application without prop drilling or complex state management solutions.
• Storing references to services, utilities, or other shared resources that need to be accessible throughout the application.
• Facilitating communication between components that do not have a direct parent-child relationship by using the context as a shared data store.

Example Usage

import { Context } from "@aerokit/sdk/core";

// Set a value in the context
Context.set("apiEndpoint", "https://api.example.com");

// Get a value from the context
const apiEndpoint = Context.get("apiEndpoint");
console.log(apiEndpoint); // Output: "https://api.example.com"

// Overwrite an existing value in the context
Context.set("apiEndpoint", "https://api.newexample.com");
const newApiEndpoint = Context.get("apiEndpoint");
console.log(newApiEndpoint); // Output: "https://api.newexample.com"

Classes

Context

get()

Retrieves the value associated with the specified name from the global context.

static get(name: string): any;

Parameter	Type	Description
name	string	The name of the context variable.

Returns

• Type: any
• Description: The context value, or undefined if the name is not found or the value is null.

set()

Stores a value in the global context under the specified name. If the name already exists, its value is overwritten.

static set(name: string, value: any): void;

Parameter	Type	Description
name	string	The name of the context variable.
value	any	The value to store.

Returns

• Type: void
• Description: