Skip to content

overview.md

Latest commit

 

History

History
73 lines (59 loc) · 3.15 KB

overview.md

File metadata and controls

73 lines (59 loc) · 3.15 KB
Raw

Platform Overview

Perry compiles TypeScript to native executables for 10 platform families from the same source code.

Supported Platforms

Platform Target Flag UI Toolkit Status
macOS (default) AppKit Full support (127/127 FFI functions)
iOS --target ios / --target ios-simulator UIKit Full support (127/127)
visionOS --target visionos / --target visionos-simulator UIKit (2D windows) Core support (2D only)
tvOS --target tvos / --target tvos-simulator UIKit Full support (focus engine + game controllers)
watchOS --target watchos / --target watchos-simulator SwiftUI (data-driven) Core support (15 widgets)
Android --target android JNI/Android SDK Full support (112/112)
Wear OS --target wearos JNI/Android SDK (shared) Android backend on a watch
Windows --target windows Win32 Full support (112/112)
Linux --target linux GTK4 Full support (112/112)
Web / WebAssembly --target web (alias --target wasm) DOM/CSS via WASM bridge Full support (168 widgets)

Cross-Compilation

# Default: compile for current platform
perry app.ts -o app

# Compile for a specific target
perry app.ts -o app --target ios-simulator
perry app.ts -o app --target visionos-simulator
perry app.ts -o app --target tvos-simulator
perry app.ts -o app --target watchos-simulator
perry app.ts -o app --target web   # alias: --target wasm
perry app.ts -o app --target windows
perry app.ts -o app --target linux
perry app.ts -o app --target android
perry app.ts -o app --target wearos   # Wear OS — Android on a watch

Platform Detection

Use the __platform__ compile-time constant to branch by platform:

{{#include ../../examples/platforms/platform_detect.ts:overview-detect}}

__platform__ is resolved at compile time. The compiler constant-folds comparisons and eliminates dead branches, so platform-specific code has zero runtime cost.

Platform Feature Matrix

Feature macOS iOS visionOS tvOS watchOS Android Windows Linux Web (WASM)
CLI programs Yes — — — — — Yes Yes —
Native UI (DOM on web) Yes Yes Yes Yes Yes Yes Yes Yes Yes
Game engines Yes Yes — Yes — Yes Yes Yes Via FFI
File system Yes Sandboxed Sandboxed Sandboxed — Sandboxed Yes Yes File System Access API
Networking Yes Yes Yes Yes Yes Yes Yes Yes fetch / WebSocket
System APIs Yes Partial Partial Partial Minimal Partial Yes Yes Partial
Widgets (WidgetKit) — Yes — — Yes — — — —
Threading Native Native Native Native Native Native Native Native Web Workers

Next Steps