@junobuild/admin
Version:
A library for interfacing with admin features of Juno
34 lines (33 loc) • 1.72 kB
TypeScript
import type { SatelliteParameters } from '../types/actor.types';
import type { CustomDomain } from '../types/customdomain.types';
/**
* Lists the custom domains for a satellite.
* @param {Object} params - The parameters for listing the custom domains.
* @param {SatelliteParameters} params.satellite - The satellite parameters.
* @returns {Promise<CustomDomain[]>} A promise that resolves to an array of custom domains.
*/
export declare const listCustomDomains: ({ satellite }: {
satellite: SatelliteParameters;
}) => Promise<CustomDomain[]>;
/**
* Sets some custom domains for a satellite.
* @param {Object} params - The parameters for setting the custom domains.
* @param {SatelliteParameters} params.satellite - The satellite parameters.
* @param {Pick<CustomDomain, "domain" | "bn_id">}[] params.domains - The custom domains - name and optional BN ID - to set.
* @returns {Promise<void[]>} A promise that resolves when the custom domains are set.
*/
export declare const setCustomDomains: ({ satellite, domains }: {
satellite: SatelliteParameters;
domains: Pick<CustomDomain, "domain" | "bn_id">[];
}) => Promise<void[]>;
/**
* Sets a custom domain for a satellite.
* @param {Object} params - The parameters for setting the custom domain.
* @param {SatelliteParameters} params.satellite - The satellite parameters.
* @param {Pick<CustomDomain, "domain" | "bn_id">} params.domain - The custom domain name and optional BN ID to set.
* @returns {Promise<void>} A promise that resolves when the custom domain is set.
*/
export declare const setCustomDomain: ({ satellite, domain }: {
satellite: SatelliteParameters;
domain: Pick<CustomDomain, "domain" | "bn_id">;
}) => Promise<void>;