Packages

gossamer

9.2.0
10.0.0 9.2.0 9.1.0 9.0.0 8.5.0 8.4.0 8.3.0 8.2.0 8.1.0 8.0.0 7.0.0 6.8.0 6.7.0 6.6.0 6.5.0 6.4.0 6.3.0 6.2.0 6.1.0 6.0.0 5.0.0 4.1.0 4.0.1 4.0.0 3.4.0 3.3.0 3.2.0 3.1.0 3.0.0 2.0.0 1.0.1 1.0.0

Web Platform and ECMAScript API bindings for Gleam's JavaScript target

HexDocs

Current section

Files

Jump to
Readme
32 Versions
1 Dependency
Dependants
Files
Activity
gossamer src gossamer writable_stream default_controller.gleam
Raw

src/gossamer/writable_stream/default_controller.gleam 

import gossamer/abort_signal.{type AbortSignal}

import gossamer/js_error.{type JsError}



/// A controller for a `WritableStream`'s underlying sink, passed to the

/// `Start`, `Write`, `Close`, and `Abort` callbacks. Used to signal stream

/// errors and access the abort signal.

///

/// See [WritableStreamDefaultController](https://developer.mozilla.org/en-US/docs/Web/API/WritableStreamDefaultController) on MDN.

///

@external(javascript, "./default_controller.type.ts", "DefaultController$")

pub type DefaultController



@external(javascript, "./default_controller.ffi.mjs", "signal")

pub fn signal(of controller: DefaultController) -> AbortSignal



/// Signals an error on the stream. Returns an error if the stream is

/// already closed or errored.

///

@external(javascript, "./default_controller.ffi.mjs", "error")

pub fn error(

  controller: DefaultController,

  reason reason: a,

) -> Result(Nil, JsError)