@types/turbostatus
TypeScript icon, indicating that this package has built-in type declarations

2.4.2 • Public • Published

Installation

npm install --save @types/turbostatus

Summary

This package contains type definitions for turbostatus (https://github.com/vigour-io/turbostatus#readme).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/turbostatus.

index.d.ts

export interface Repository {
    name: string;
    path: string;
}

export interface Description {
    commitsSinceTag: string | false;
    hash: string;
    nearestTag: string | false;
}

export function checkout(folder: string, commit: string): Promise<string>;
export function clone(origin: string, folder: string): Promise<string>;
export function describe(folder: string): Promise<Description>;
export function getBranch(folder: string): Promise<string>;
export function getBranchFast(folder: string): Promise<string>;
export function getLocalCommit(folder: string): Promise<string>;
export function getMergeBase(folder: string): Promise<string>;
export function getOrigin(folder: string): Promise<string>;
export function getRemoteCommit(folder: string): Promise<string>;
export function getRepos(folder: string, wildcard?: string): Promise<Repository[]>;
export function hasUncommited(folder: string): Promise<boolean>;
export function hasUntracked(folder: string): Promise<boolean>;
export function info(repo: Repository, remotes?: boolean): Promise<Repository>;
export function isRepo(folder: string): Promise<boolean>;
export function references(folder: string): Promise<string>;

Additional Details

  • Last updated: Tue, 07 Nov 2023 15:11:36 GMT
  • Dependencies: none

Credits

These definitions were written by Florian Keller.

Readme

Keywords

none

Package Sidebar

Install

npm i @types/turbostatus

Weekly Downloads

2

Version

2.4.2

License

MIT

Unpacked Size

4.95 kB

Total Files

5

Last publish

Collaborators

  • types