https://github.com/kf99916/jscontextfoundation

JSContextFoundation is a Swift adapter for the JavaScriptCore Framework to build up the JavaScript runtime environment.
https://github.com/kf99916/jscontextfoundation

cocoapods javascript javascriptcore-framework jscontext swift swift-adapter

Last synced: about 2 months ago
JSON representation

JSContextFoundation is a Swift adapter for the JavaScriptCore Framework to build up the JavaScript runtime environment.

• Host: GitHub
• URL: https://github.com/kf99916/jscontextfoundation
• Owner: kf99916
• License: mit
• Created: 2016-05-14T01:48:58.000Z (about 10 years ago)
• Default Branch: master
• Last Pushed: 2018-01-03T02:38:03.000Z (over 8 years ago)
• Last Synced: 2025-02-17T05:34:25.021Z (over 1 year ago)
• Topics: cocoapods, javascript, javascriptcore-framework, jscontext, swift, swift-adapter
• Language: Swift
• Homepage:
• Size: 55.7 KB
• Stars: 2
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# JSContextFoundation

JSContextFoundation is a Swift adapter for the JavaScriptCore Framework to build up the JavaScript runtime environment.

[![CocoaPods](https://img.shields.io/cocoapods/dt/JSContextFoundation.svg)](https://cocoapods.org/pods/JSContextFoundation)

[![GitHub stars](https://img.shields.io/github/stars/kf99916/JSContextFoundation.svg)](https://github.com/kf99916/JSContextFoundation/stargazers)

[![GitHub forks](https://img.shields.io/github/forks/kf99916/JSContextFoundation.svg)](https://github.com/kf99916/JSContextFoundation/network)

[![CocoaPods Compatible](https://img.shields.io/cocoapods/v/JSContextFoundation.svg)](https://cocoapods.org/pods/JSContextFoundation)

[![Platform](https://img.shields.io/cocoapods/p/JSContextFoundation.svg)](https://github.com/kf99916/JSContextFoundation)

[![GitHub license](https://img.shields.io/github/license/kf99916/JSContextFoundation.svg)](https://github.com/kf99916/JSContextFoundation/blob/master/LICENSE)

## Requirements

- iOS 8.0 or higher

- Swift 2.3 or higher

## Installation

- [CocoaPods](http://cocoapods.org/):

Swift 2.3

```ruby

pod 'JSContextFoundation', '~> 0.0.1'

```

Swift 3.1

```ruby

pod 'JSContextFoundation', '~> 0.1.1'

```

- [Swift Package Manager](https://swift.org/package-manager/):

Swift 2.3

```

.Package(url: "https://github.com/kf99916/JSContextFoundation.git", majorVersion: 0.0.1)

```

Swift 3.1

```

.Package(url: "https://github.com/kf99916/JSContextFoundation.git", majorVersion: 0.1.1)

```

## JavaScript Runtime Environment

JSContextFoundation builds up the global objects for the JavaScript runtime environment to allow you execute JavaScript code like as in browser or Node.js. Here is the support list for the global objects:

```javascript

global;

window;

console

  .log([data][, ...]);

  .info([data][, ...]);

  .warn([data][, ...]);

  .error([data][, ...]);

```

## Usage

```swift

import JSContextFoundation

let jsContext = JSContextFoundation()

```

### Import JavaScript Module

To import JavaScript module, the source of module can be file path or URL: 

#### File Path

```swift

let path = NSBundle(forClass: self.dynamicType).pathForResource("Module", ofType: "js")!

do {

  try jsContext.requireWithPath(path)

} catch JSContextFoundationError.FileNotFound {

  print(path + " is not found")

} catch JSContextFoundationError.FileNotLoaded {

  print(path + " cannot be loaded")

} catch {

  print("Unknow Exception")

}

// ...

```

#### URL

```swift

let url = NSURL(string: "https://FQDN/Module.js")!

jsContext.requireWithUrl(url, completionHandler: {error in

   if let error = error {

      switch error {

        case JSContextFoundationError.FileNotFound:

            print(url.absoluteString + " is not found")

        case JSContextFoundationError.FileNotDownloaded:

            print(url.absoluteString + " is not downloaded")

        default:

            print("Unknown Error")

        }

        

        return

    }

    //  ...

})

```

All other usage is the same as JSContext. See [JSContext in the Apple document](https://developer.apple.com/library/ios/documentation/JavaScriptCore/Reference/JSContext_Ref/index.html) for details.

## Apps using JSContextFoundation

If you are using JSContextFoundation in your app and want to be listed here, simply create a pull request.

I am always curious who is using my projects :)

[Hikingbook](https://itunes.apple.com/app/id1067838748) - by Zheng-Xiang Ke

![Hikingbook](apps/Hikingbook.png)

## Author

Zheng-Xiang Ke, kf99916@gmail.com

## License

JSContextFoundation is available under the MIT license. See the LICENSE file for more info.