Skip to content

open ​

Open the repository for a submodule.

This will only work if the submodule is checked out into the working directory.

Signature ​

ts
class Submodule {
  open(signal?: AbortSignal | null | undefined): Promise<Repository>;
}

Parameters ​

  • signalnull | AbortSignal

    Optional AbortSignal to cancel the operation.

Returns ​

  • Promise<Repository>

    The repository.

Released under the MIT License.