@shipengine/connect-loader/lib/read-definition.d.ts

Internal library for loading ShipEngine Connect apps

import { InlineOrReference, InlineOrReferenceArray } from '@shipengine/connect-sdk';
/**
 * Reads an ShipEngine Connect definition that is expected to be a single value.
 * The definition can be any of:
 *
 * - an inline value
 * - a YAML file path
 * - a JSON file path
 * - a JavaScript file path
 * - a dynamic import via `require()` or `import()`
 */
export declare function readDefinitionValue<T>(definition: InlineOrReference<T>, cwd: string, fieldName: string): Promise<T>;
export declare function readDefinitions<T>(definition: InlineOrReferenceArray<T>, cwd: string, fieldName: string): Promise<[T[], string]>;
export declare function readDefinitions<T>(definition: InlineOrReferenceArray<T> | undefined, cwd: string, fieldName: string): Promise<[T[] | undefined, string]>;
export declare function readDefinition<T>(definition: InlineOrReference<T>, cwd: string, fieldName: string): Promise<[T, string]>;
export declare function readDefinition<T>(definition: InlineOrReference<T> | undefined, cwd: string, fieldName: string): Promise<[T | undefined, string]>;