Interface PackageSource

snowpack/src/types.ts:376–408

/** PackageSource - a common interface for loading and interacting with dependencies.  */
export interface PackageSource {
  /**
   * Do any work needed before starting the dev server or build. Either will wait
   * for this to complete before continuing. Example: For "local", this involves
   * running esinstall (if needed) to prepare your local dependencies as ESM.
   */
  prepare(): Promise<void>;
  /**
   * Like prepare(), but only looks at a single file and meant to run at anytime,
   * usually after the server has already started and is running.
   */
  prepareSingleFile(fileLoc: string): Promise<void>;
  /**
   * Load a dependency with the given spec (ex: "/pkg/react" -> "react")
   * If load fails or is unsuccessful, reject the promise.
   */
  load(
    spec: string,
    options: {isSSR: boolean},
  ): Promise<undefined | {contents: Buffer | string; imports: InstallTarget[]}>;
  /** Resolve a package import to URL (ex: "react" -> "/pkg/react") */
  resolvePackageImport(
    spec: string,
    options?: {source?: string; importMap?: ImportMap; depth?: number},
  ): Promise<string>;
  /** Modify the build install config for optimized build install. */
  modifyBuildInstallOptions(
    installOptions: EsinstallOptions,
    installTargets: InstallTarget[],
  ): Promise<EsinstallOptions>;
  getCacheFolder(): string;
  clearCache(): void | Promise<void>;
}

export type ScannableExt =
  | '.astro'