PlaygroundAPI

public protocol PlaygroundAPI

Describes the API for Playground

  • Make a nef Playground compatible with 3rd-party libraries.

    Declaration

    Swift

    static func nef(name: String, output: URL, platform: Platform, dependencies: PlaygroundDependencies) -> EnvIO<ProgressReport, nef.Error, URL>

    Parameters

    name

    Name for the output nef Playground.

    output

    Folder where to write the nef Playground.

    platform

    Target to use for compiling Xcode Playground.

    dependencies

    Dependencies to use for the compiler.

    Return Value

    An EnvIO to perform IO operations that produce errors of type nef.Error and the nef Playground output of the type URL, having access to an immutable environment of type ProgressReport.

  • Make a nef Playground compatible with 3rd-party libraries from an Xcode Playground.

    Declaration

    Swift

    static func nef(xcodePlayground: URL, name: String, output: URL, platform: Platform, dependencies: PlaygroundDependencies) -> EnvIO<ProgressReport, nef.Error, URL>

    Parameters

    xcodePlayground

    Xcode Playground to transform to nef Playground.

    name

    Name for the output nef Playground.

    output

    Folder where to write the nef Playground.

    platform

    Target to use for compiling Xcode Playground.

    dependencies

    Dependencies to use for the compiler.

    Return Value

    An EnvIO to perform IO operations that produce errors of type nef.Error and the nef Playground output of the type URL, having access to an immutable environment of type ProgressReport.