checkoutIndex

작업 트리의 파일들을 인덱스의 내용과 일치하도록 업데이트해요.

시그니처

class Repository {
  checkoutIndex(
    index?: Index | undefined | null,
    options?: CheckoutOptions | undefined | null,
  ): void;
}

파라미터

• indexnull | Index
  

  체크아웃할 인덱스. 제공되지 않으면 리포지토리의 인덱스를 사용해요.

• optionsnull | CheckoutOptions
  

  체크아웃 옵션

  • allowConflictsboolean
    

    안전 모드에서 충돌이 있을 때 체크아웃을 취소하는 대신 안전한 파일 업데이트를 적용해요. 기본값은 false예요.

  • ancestorLabelstring
    

    충돌의 공통 조상 측 이름

  • conflictStyleDiff3boolean
    

    충돌에 대한 diff3 형식 파일에 공통 조상 데이터를 포함할지 여부를 나타내요. 기본값은 false예요.

  • conflictStyleMergeboolean
    

    충돌에 대해 일반 병합 파일을 작성해야 하는지를 나타내요. 기본값은 false예요.

  • dirPermnumber
    

    새 디렉토리가 생성되는 모드를 설정해요. 기본값은 0755예요.

  • disableFiltersboolean
    

    CRLF 변환과 같은 필터를 적용할지 여부를 나타내요.

  • disablePathspecMatchboolean
    

    path에 지정된 경로를 pathspec이 아닌 정확한 파일 경로로 처리해요.

  • dryRunboolean
    

    이 체크아웃이 충돌을 확인하지만 실제 변경은 하지 않는 드라이런을 수행해야 함을 나타내요.

  • filePermnumber
    

    새 파일이 생성되는 모드를 설정해요. 기본값은 blob에서 지정한 대로 0644 또는 0755예요.

  • forceboolean
    

    수정된 파일을 잠재적으로 삭제하는 것을 포함하여 작업 디렉토리를 대상과 일치시키기 위해 필요한 모든 조치를 취해요.

  • ourLabelstring
    

    충돌의 공통 우리 측 이름

  • overwriteIgnoredboolean
    

    체크아웃 중에 무시된 파일을 덮어쓸지 여부를 나타내요. 기본값은 true예요.

  • pathstring
    

    체크아웃할 경로를 추가해요. disablePathspecMatch가 설정되지 않는 한 경로는 <a href="https://git-scm.com/docs/gitglossary.html#Documentation/gitglossary.txt-aiddefpathspecapathspec">pathspec</a> 패턴이에요. 경로가 지정되지 않으면 모든 파일이 체크아웃돼요. 그렇지 않으면 지정된 경로만 체크아웃돼요.

  • recreateMissingboolean
    

    안전 모드에서 존재하지 않는 파일을 생성해요. 기본값은 false예요.

  • refreshboolean
    

    작업 전에 인덱스와 git 속성을 디스크에서 새로 고쳐야 하는지를 나타내요. 기본값은 true예요.

  • removeIgnoredboolean
    

    작업 디렉토리에서 무시된 파일을 제거해요. 기본값은 false예요.

  • removeUntrackedboolean
    

    작업 디렉토리에서 추적되지 않은 파일을 제거해요. 기본값은 false예요.

  • safeboolean
    

    체크아웃이 안전하게 수행되어야 함을 나타내며, 새 파일 생성은 허용하지만 기존 파일이나 변경 사항은 덮어쓰지 않아요. 이것이 기본값이에요.

  • skipUnmergedboolean
    

    병합되지 않은 인덱스 항목이 있는 파일을 건너뛰어요. 기본값은 false예요.

  • targetDirstring
    

    체크아웃할 디렉토리를 설정

  • theirLabelstring
    

    충돌의 공통 그들 측 이름

  • updateIndexboolean
    

    체크아웃이 업데이트된 파일의 정보를 인덱스에 쓰는 것을 방지해요. 기본값은 true예요.

  • updateOnlyboolean
    

    이미 존재하는 파일의 내용만 업데이트해요. 설정하면 파일이 생성되거나 삭제되지 않아요. 기본값은 false예요.

  • useOursboolean
    

    충돌 시 파일의 스테이지 2 버전("ours")을 사용하여 체크아웃을 진행할지 여부를 나타내요. 기본값은 false예요.

  • useTheirsboolean
    

    충돌 시 파일의 스테이지 3 버전("theirs")을 사용하여 체크아웃을 진행할지 여부를 나타내요. 기본값은 false예요.