@bavenir/spade-node-js-client/dist/types/config.d.ts

A client-side JavaScript library that can be used to iteract with Data Broker's API.

/**
 * Copyright (C) 2024 bAvenir
 *
 * This program and the accompanying materials are made
 * available under the terms of the Eclipse Public License 2.0
 * which is available at https://www.eclipse.org/legal/epl-2.0/
 *
 * SPDX-License-Identifier: EPL-2.0
 */
/**
 * Configuration options for the Data Broker client.
 *
 * @interface DataBrokerConfig
 *
 * @property {string} url - The Data Broker URL without the protocol (e.g., `example.com`).
 * @property {string} clientId - The client ID, which can be generated using the UI or API.
 * @property {string} clientSecret - The client secret, which can be generated using the UI or API.
 *
 * @example
 * const config: DataBrokerConfig = {
 *   url: 'example.com',
 *   clientId: 'your-client-id',
 *   clientSecret: 'your-client-secret'
 * };
 */
export interface DataBrokerConfig {
    url: string;
    clientId: string;
    clientSecret: string;
}