@rechunk/core/src/index.ts

Core functionality for ReChunk dynamic code loading and chunk management in React Native

/**
 * This polyfill file adds support for the global `btoa` and `atob` methods
 * if they are not already defined in the environment.
 */
import './polyfill';

import {TinyEmitter} from 'tiny-emitter';

import {ChunkManager} from './ChunkManager';
import type {Configuration, ValidateReChunkEntry} from './types';

/**
 * Asynchronously imports a chunk using the shared ChunkManager instance.
 * @param {string} chunkId - The ID of the chunk to import.
 * @returns {Promise<*>} A promise resolving to the imported JavaScript component.
 */
export async function importChunk<T extends string>(
  chunkId: ValidateReChunkEntry<T>,
): Promise<any> {
  // Using shared ChunkManager instance to import the chunk
  return ChunkManager.shared.importChunk(chunkId);
}

/**
 * Adds configuration settings to the ChunkManager.
 * This function is used to configure the ChunkManager with specified settings such as public key, resolver function, verification flag, and global object.
 * @param {Configuration} config - The configuration object for ChunkManager.
 */
function addConfiguration(config: Configuration) {
  // Delegates the configuration addition to the shared instance of ChunkManager
  ChunkManager.shared.addConfiguration(config);
}

/**
 * Registers an event listener with the specified event name and callback function.
 * Optionally, you can provide a context object (`ctx`) to bind `this` when the callback is invoked.
 * @param {string} event - The name of the event to listen for.
 * @param {Function} callback - The function to be invoked when the event is emitted.
 * @param {any} [ctx] - (Optional) The context to bind to the callback function.
 * @returns {TinyEmitter} - The `TinyEmitter` instance for chaining purposes.
 */
export function on(event: string, callback: Function, ctx?: any): TinyEmitter {
  // Calls the `on` method of the shared `ChunkManager` instance to register the event listener.
  // Passes the provided event name, callback function, and optional context to the `on` method.
  return ChunkManager.shared.on(event, callback, ctx);
}

/**
 * Exports the addResolver function under the default namespace,
 * making it accessible under the ReChunk namespace.
 */
export default {
  addConfiguration,
};

/**
 * This statement exports all named exports from the './types' module.
 * It effectively re-exports all exports from './types', allowing them to be imported from this module.
 */
export * from './types';