Skip to main content

shell

파일과 URL을 기본 애플리케이션으로 관리한다.

프로세스: Main, Renderer (비샌드박스 환경에서만)

shell 모듈은 데스크톱 통합과 관련된 기능을 제공한다.

사용자의 기본 브라우저에서 URL을 여는 예제:

const { shell } = require('electron')

shell.openExternal('https://github.com')

참고: shell 모듈은 렌더러 프로세스에서 사용할 수 있지만, 샌드박스 환경에서는 동작하지 않는다.

메서드

shell 모듈은 다음과 같은 메서드를 제공한다:

shell.showItemInFolder(fullPath)

  • fullPath string

파일 관리자에서 지정한 파일을 표시한다. 가능한 경우 해당 파일을 선택한다.

shell.openPath(path)

  • path string

Promise<string>를 반환한다. 실패한 경우 해당 오류 메시지를 포함한 문자열로 resolve되며, 성공한 경우 빈 문자열("")로 resolve된다.

주어진 파일을 데스크톱의 기본 방식으로 연다.

shell.openExternal(url[, options])

  • url string - 윈도우에서는 최대 2081자까지 허용한다.
  • options Object (선택 사항)
    • activate boolean (선택 사항) macOS - 열린 애플리케이션을 포그라운드로 가져올지 여부. 기본값은 true이다.
    • workingDirectory string (선택 사항) Windows - 작업 디렉토리를 지정한다.
    • logUsage boolean (선택 사항) Windows - 사용자 시작 프로그램을 추적하고 자주 사용하는 프로그램 등의 동작을 활성화한다. 기본값은 false이다.

반환값: Promise<void>

주어진 외부 프로토콜 URL을 데스크톱의 기본 방식으로 연다. (예: 사용자의 기본 메일 에이전트에서 mailto: URL을 열기).

shell.trashItem(path)

  • path string - 휴지통으로 이동할 아이템의 경로.

Promise<void>를 반환 - 작업이 완료되면 이행된다. 요청한 아이템을 삭제하는 동안 오류가 발생하면 거부된다.

이 함수는 주어진 경로의 아이템을 운영체제별 휴지통 위치로 이동한다. macOS에서는 Trash, Windows에서는 휴지통, Linux에서는 데스크톱 환경에 따라 특정 위치로 이동한다.

shell.beep()를 사용하면 시스템에서 비프음을 재생한다. 이 메서드는 주로 사용자에게 알림을 주거나 특정 이벤트를 강조할 때 활용된다.

shell.writeShortcutLink(shortcutPath[, operation], options) Windows

  • shortcutPath string
  • operation string (선택 사항) - 기본값은 create이며, 다음 중 하나를 선택할 수 있다:
    • create - 새로운 바로 가기를 생성하고, 필요한 경우 기존 바로 가기를 덮어쓴다.
    • update - 기존 바로 가기의 지정된 속성만 업데이트한다.
    • replace - 기존 바로 가기를 덮어쓴다. 바로 가기가 존재하지 않으면 실패한다.
  • options ShortcutDetails

boolean을 반환한다 - 바로 가기가 성공적으로 생성되었는지 여부를 나타낸다.

shortcutPath에 바로 가기 링크를 생성하거나 업데이트한다.

shell.readShortcutLink(shortcutPath) Windows

  • shortcutPath string

ShortcutDetails를 반환한다.

shortcutPath에 위치한 바로가기 링크를 해석한다. 오류가 발생하면 예외가 발생한다.