<commit_before>Platform API documentation
==========================

## Global API functions ##

#### nativeBridgeReady()

An optional callback to invoke after the web view has finished loading and the bridge APIs are ready for use. Note,
this function is called *from* the Native application and is not bound to the NativeBridge object.

**Parameters**

- `error` (object) - Error
- `bridge` (object) - The native bridge API object.

**Example**

```
// wait for the bridge to be ready

function bridgeReady() {
  // web view is loaded and bridge is ready for use
}

if (window.NativeBridge === undefined) {
  window.nativeBridgeReady = function(error, bridge) {
    bridgeReady();
  }
} else {
  bridgeReady();
}
```<commit_msg>update docs<commit_after>Platform API documentation
==========================

The platform API is a JavaScript API that provides a bridge to native device APIs for iOS and Android. [Zoot](https://github.com/TheHolyGrail/Zoot) is the implementation for iOS that bridges the platform API to native Objective-C-based APIs. Her twin, [Dingo](https://github.com/TheHolyGrail/Dingo), is a Java framework that bridges the API to native Android APIs. 

The platform API enables web applications to use native device APIs for building hybrid experiences.

## Global Functions ##

#### nativeBridgeReady()

An optional callback function to invoke after the web view has finished loading and the bridge APIs are ready for use. Note,
this function is called *from* the Native application and is not bound to the NativeBridge object.

**Parameters**

- `error` (object) - Error
- `bridge` (object) - The native bridge API object.

**Example**

```
// wait for the bridge to be ready

function bridgeReady() {
  // web view is loaded and bridge is ready for use
}

if (window.NativeBridge === undefined) {
  window.nativeBridgeReady = function(error, bridge) {
    bridgeReady();
  }
} else {
  bridgeReady();
}
```
{'fraction_non_alphanumeric': 0.11995863495346432, 'fraction_numerical': 0.0, 'mean_word_length': 4.330578512396694, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 2, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '2795242', 'n_tokens_mistral': 527, 'n_tokens_neox': 494, 'n_words': 233}