Interface Provider

OptionalparseUrlPkg

• parseUrlPkg(
      this: ProviderContext,
      url: string,
  ):
      | ExactPackage
      | { pkg: ExactPackage; subpath: `./${string}`; layer: string }

  Parameters

  • this: ProviderContext
  • url: string

  Returns ExactPackage | { pkg: ExactPackage; subpath: `./${string}`; layer: string }

OptionalpkgToUrl

• pkgToUrl(
      this: ProviderContext,
      pkg: ExactPackage,
      layer?: string,
  ): `${string}/` | Promise<`${string}/`>

  Parameters

  • this: ProviderContext
  • pkg: ExactPackage
  • Optionallayer: string

  Returns `${string}/` | Promise<`${string}/`>

OptionalresolveLatestTarget

• resolveLatestTarget(
      this: ProviderContext,
      target: LatestPackageTarget,
      layer: string,
      parentUrl: string,
      resolver: Resolver,
  ): Promise<ExactPackage>

  Parameters

  • this: ProviderContext
  • target: LatestPackageTarget
  • layer: string
  • parentUrl: string
  • resolver: Resolver

  Returns Promise<ExactPackage>

OptionalownsUrl

• ownsUrl(this: ProviderContext, url: string): boolean

  Parameters

  • this: ProviderContext
  • url: string

  Returns boolean

OptionalresolveBuiltin

• resolveBuiltin(
      this: ProviderContext,
      specifier: string,
      env: string[],
  ): string | Install

  Parameters

  • this: ProviderContext
  • specifier: string
  • env: string[]

  Returns string | Install

OptionalgetPackageConfig

• getPackageConfig(this: ProviderContext, pkgUrl: string): Promise<PackageConfig>

  Parameters

  • this: ProviderContext
  • pkgUrl: string

  Returns Promise<PackageConfig>

OptionalgetFileList

• getFileList(this: ProviderContext, pkgUrl: string): Promise<Set<string>>

  Parameters

  • this: ProviderContext
  • pkgUrl: string

  Returns Promise<Set<string>>

Optionaldownload

• download(
      this: ProviderContext,
      pkg: ExactPackage,
  ): Promise<Record<string, Uint8Array<ArrayBufferLike>>>

  Parameters

  • this: ProviderContext
  • pkg: ExactPackage

  Returns Promise<Record<string, Uint8Array<ArrayBufferLike>>>

Optionalpublish

• publish(
      this: ProviderContext,
      pkg: ExactPackage,
      files: Record<string, string | ArrayBuffer>,
      importMap: ImportMap,
      imports: string[],
  ): Promise<DeployOutput>

  Publish a package to the provider This is an optional method that providers can implement to support package publishing

  Parameters

  • this: ProviderContext
  • pkg: ExactPackage
  • files: Record<string, string | ArrayBuffer>
  • importMap: ImportMap

    Optional import map to include with the publish
  • imports: string[]

  Returns Promise<DeployOutput>

Optionalauth

• auth(
      this: ProviderContext,
      options: {
          username?: string;
          verify?: (url: string, instructions: string) => void;
      },
  ): Promise<{ token: string }>

  Authenticate with the provider This is an optional method that providers can implement to support authentication

  Parameters

  • this: ProviderContext
  • options: { username?: string; verify?: (url: string, instructions: string) => void }

  Returns Promise<{ token: string }>

  A promise resolving to an authentication token

Optionalconfigure

• configure(this: ProviderContext, config: any): void

  Parameters

  • this: ProviderContext
  • config: any

  Returns void

OptionalsupportedLayers