Sftp

constructor

• new Sftp(): Sftp

  반환값

  Sftp

정적 읽기 전용AttributesResult

정적 읽기 전용HostKeyType

정적 읽기 전용ListingResult

정적 읽기 전용PathResult

정적 읽기 전용Result

close

• close(): void

  즉시 SSH 연결을 해제하고 대기 중인 작업을 깨웁니다.

  반환값

  void

  소스와 상속

connect

• connect(
      server: IpAddress,
      port?: number,
      timeout?: SftpTimeout,
  ): Promise<SftpResult>

  SSH 핸드셰이크를 수행하며 기본 포트는 22입니다. 이후 login으로 인증합니다. 호스트 신뢰성은 자동으로 검증하지 않습니다. 애플리케이션은 로그인 전에 getSessionInfo로 호스트 지문을 검증할 수 있습니다.

  매개변수

  server

  IpAddress

  port

  number = 22

  timeout

  SftpTimeout = Time.Zero

  반환값

  Promise<SftpResult>

  소스와 상속

createDirectory

• createDirectory(
      path: string,
      permissions?: number,
      timeout?: SftpTimeout,
  ): Promise<SftpResult>

  원격 디렉터리를 생성하며 기본 Unix 권한은 0o755입니다.

  매개변수

  path

  string

  permissions

  number = 0o755

  timeout

  SftpTimeout = Time.Zero

  반환값

  Promise<SftpResult>

  소스와 상속

deleteDirectory

• deleteDirectory(path: string, timeout?: SftpTimeout): Promise<SftpResult>

  비어 있는 원격 디렉터리를 삭제합니다.

  매개변수

  path

  string

  timeout

  SftpTimeout = Time.Zero

  반환값

  Promise<SftpResult>

  소스와 상속

deleteFile

• deleteFile(path: string, timeout?: SftpTimeout): Promise<SftpResult>

  원격 파일 또는 심볼릭 링크를 삭제합니다.

  매개변수

  path

  string

  timeout

  SftpTimeout = Time.Zero

  반환값

  Promise<SftpResult>

  소스와 상속

disconnect

• disconnect(timeout?: SftpTimeout): Promise<SftpResult>

  즉시 세션을 닫고 성공 결과를 반환합니다. timeout은 인수 검증에만 사용합니다.

  매개변수

  timeout

  SftpTimeout = Time.Zero

  반환값

  Promise<SftpResult>

  소스와 상속

download

• download(
      path: string,
      callback: SftpDownloadCallback,
      offset?: bigint,
      timeout?: SftpTimeout,
  ): Promise<SftpResult>

  바이트 오프셋 offset부터 청크 단위로 다운로드하며 callback을 순서대로 기다립니다. 최대 오프셋은 2^53-1입니다.

  매개변수

  path

  string

  callback

  SftpDownloadCallback

  offset

  bigint = 0n

  timeout

  SftpTimeout = Time.Zero

  반환값

  Promise<SftpResult>

  소스와 상속

getAttributes

• getAttributes(
      path: string,
      followLinks?: boolean,
      timeout?: SftpTimeout,
  ): Promise<SftpAttributesResult>

  원격 속성을 조회합니다. followLinks는 기본적으로 심볼릭 링크를 따르며, false이면 링크 자체를 조회합니다.

  매개변수

  path

  string

  followLinks

  boolean = true

  timeout

  SftpTimeout = Time.Zero

  반환값

  Promise<SftpAttributesResult>

  소스와 상속

getDirectoryListing

• getDirectoryListing(
      path: string,
      timeout?: SftpTimeout,
  ): Promise<SftpListingResult>

  디렉터리 항목과 속성을 비동기로 읽습니다.

  매개변수

  path

  string

  timeout

  SftpTimeout = Time.Zero

  반환값

  Promise<SftpListingResult>

  소스와 상속

getSessionInfo

• getSessionInfo(): undefined | SftpSessionInfo

  호스트 공개 키와 협상한 알고리즘의 스냅샷을 반환하며, 핸드셰이크 정보가 준비되지 않았으면 undefined입니다.

  반환값

  undefined | SftpSessionInfo

  소스와 상속

getWorkingDirectory

• getWorkingDirectory(timeout?: SftpTimeout): Promise<SftpPathResult>

  현재 세션에 대한 서버의 기본 작업 디렉터리를 조회합니다.

  매개변수

  timeout

  SftpTimeout = Time.Zero

  반환값

  Promise<SftpPathResult>

  소스와 상속

login

• login(
      name: string,
      password: string,
      timeout?: SftpTimeout,
  ): Promise<SftpResult>

  사용자 이름과 암호로 비동기 인증하고 SFTP 채널을 엽니다.

  매개변수

  name

  string

  password

  string

  timeout선택 사항

  SftpTimeout

  반환값

  Promise<SftpResult>

  소스와 상속
• login(
      name: string,
      publicKey: string | Uint8Array,
      privateKey: string | Uint8Array,
      passphrase?: string,
      timeout?: SftpTimeout,
  ): Promise<SftpResult>

  일치하는 공개 키와 개인 키 및 선택적 개인 키 암호로 비동기 인증합니다. 키 인수는 파일 경로가 아닌 내용입니다.

  매개변수

  name

  string

  publicKey

  string | Uint8Array

  privateKey

  string | Uint8Array

  passphrase선택 사항

  string

  timeout선택 사항

  SftpTimeout

  반환값

  Promise<SftpResult>

  소스와 상속

rename

• rename(
      oldPath: string,
      newPath: string,
      overwrite?: boolean,
      timeout?: SftpTimeout,
  ): Promise<SftpResult>

  원격 경로 이름을 변경합니다. overwrite가 true이면 서버가 OpenSSH 덮어쓰기 이름 변경 확장을 지원해야 합니다.

  매개변수

  oldPath

  string

  newPath

  string

  overwrite

  boolean = false

  timeout

  SftpTimeout = Time.Zero

  반환값

  Promise<SftpResult>

  소스와 상속

resolvePath

• resolvePath(path: string, timeout?: SftpTimeout): Promise<SftpPathResult>

  서버에 정규화된 절대 경로 확인을 요청합니다.

  매개변수

  path

  string

  timeout

  SftpTimeout = Time.Zero

  반환값

  Promise<SftpPathResult>

  소스와 상속

upload

• upload(
      path: string,
      callback: SftpUploadCallback,
      permissions?: number,
      truncate?: boolean,
      append?: boolean,
      offset?: bigint,
      timeout?: SftpTimeout,
  ): Promise<SftpResult>

  콜백이 제공하는 청크로 파일을 업로드하며 각 청크의 쓰기 완료를 기다립니다.

  매개변수

  path

  string

  원격 파일 경로.

  callback

  SftpUploadCallback

  버퍼를 채우고 size를 설정하는 콜백.

  permissions

  number = 0o644

  새 파일 권한. 기본값은 0o644입니다.

  truncate

  boolean = true

  기존 파일을 비울지 여부. 기본값은 true입니다.

  append

  boolean = false

  추가 쓰기를 요청할지 여부. 기본값은 false입니다.

  offset

  bigint = 0n

  시작 바이트 오프셋. 기본값은 0n, 최대값은 2^53-1입니다.

  timeout

  SftpTimeout = Time.Zero

  진행이 없을 때의 제한 시간 설정. 기본적으로 제한이 없습니다.

  반환값

  Promise<SftpResult>

  소스와 상속