@sassoftware/vi-api
Version:
Types used in the SAS Visual Investigator API
23 lines (22 loc) • 922 B
TypeScript
export interface I18nResources {
[key: string]: string | I18nResources;
}
/**
* @deprecated Use window.sas.viInit.registerResourceBundle to register resources before the rest of the SAS Visual Investigator API is ready.
* This API provides the resource functionality in SAS Visual Investigator.
*
* Accessed from the window at `window.sas.vi.resource`.
*
* @example window.sas.vi.resource.registerResourceBundle("bundleName", resources);
* @category API
*/
export interface ResourceApi {
/**
* @method
* @description Register a resource bundle with the Resource Service.
* @param bundleName {string} Name for the bundle to be stored in the resource cache.
* @param resources {I18nResources} Object containing the resources to be added for the bundle
* specified by the bundleName parameter.
*/
registerResourceBundle(bundleName: string, resources: I18nResources): void;
}