submoduleStatus

서브모듈의 상태를 가져와요.

이 함수는 서브모듈을 확인하고 상태를 판단하려고 해요. SubmoduleStatus 값들의 조합을 반환해요.

시그니처

class Repository {
  submoduleStatus(name: string, ignore: SubmoduleIgnore): number;
}

파라미터

• name필수 · string
  

  서브모듈의 이름

• ignore필수 · SubmoduleIgnore
  

  따를 무시 규칙

  서브모듈 ignore 값
  
  이 값들은 submodule.$name.ignore 설정 값에 대한 설정을 나타내며, 서브모듈 상태를 가져올 때 작업 디렉터리를 얼마나 깊게 확인할지 말해요.

반환 값

• number
  

  SubmoduleStatus 값들의 조합

예제

import { openRepository, submoduleStatusContains, SubmoduleStatus } from 'es-git';

const repo = await openRepository('...');
const status = repo.submoduleStatus('mysubmodule', 'None');

console.log(
  submoduleStatusContains(status, SubmoduleStatus.InHead | SubmoduleStatus.InIndex)
); // true