Nitro

https://nitro.margelo.com/docs/what-is-nitro

Admin

Nitro is a framework for building powerful and fast native modules for JavaScript using C++, Swift,...

Tokens:1,091

Snippets:14

Trust Score:7.1

Update:8 months ago

Show doc for...

Tokens:

Raw

### Implement Hybrid Object (Swift)

Source: https://nitro.margelo.com/docs/what-is-nitro/index

Provides a Swift implementation for a Hybrid Object, adhering to the interface defined in TypeScript. This example shows how to implement properties and methods for native execution.

```swift
class HybridMath : HybridMathSpec {
  var pi: Double {
    return Double.pi
  }
  func add(a: Double, b: Double) -> Double {
    return a + b
  }
}

```

```swift
class HybridMath : HybridMathSpec {
  func add(a: Double, b: Double) -> String { 
//  Compile-error: Expected Double! ^ 
    return a + b
  }
}

```

--------------------------------

### Access Hybrid Object from JavaScript (React Native)

Source: https://nitro.margelo.com/docs/what-is-nitro/index

Demonstrates how to create and use a Hybrid Object from JavaScript within a React Native environment. It utilizes the `NitroModules.createHybridObject` function to instantiate the native object.

```javascript
import { NitroModules } from 'react-native-nitro-modules'

const math = NitroModules.createHybridObject<Math>('Math')
const result = math.add(5, 7)

```

--------------------------------

### Define Hybrid Object Interface (TypeScript)

Source: https://nitro.margelo.com/docs/what-is-nitro/index

Defines the TypeScript interface for a Hybrid Object, specifying its properties and methods. This serves as a contract for the native implementation. It includes platform-specific hints, like 'swift' for iOS.

```typescript
interface Math  
  extends HybridObject<{ ios: 'swift' }> {
  readonly pi: number
  add(a: number, b: number): number
}

```

```typescript
interface Math extends HybridObject<{ ... }> {
  add(a: number, b: number): number
}

```

```typescript
interface Image extends HybridObject<{ ... }> {
  readonly width: number
  readonly height: number
  saveToFile(path: string): Promise<void>
}

interface ImageEditor extends HybridObject<{ ... }> {
  loadImage(path: string): Promise<Image>
  crop(image: Image, size: Size): Image
}

```

```typescript
interface Math extends HybridObject<{ ... }> {
  getValue(): number
  getValueOrNull(): number | undefined
}

```

Tokens:

Raw