Options
All
  • Public
  • Public/Protected
  • All
Menu

External module "sources/external"

Copyright 2019 Google Inc. All Rights Reserved. Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Index

Type aliases

Variables

Functions

Type aliases

NextFunc

NextFunc<T>: function

Type parameters

  • T

Type declaration

    • (v: T | unique symbol): void
    • Parameters

      • v: T | unique symbol

      Returns void

Variables

Const EOF

EOF: unique symbol = Symbol()

Symbol indicating the end of a stream. Used with external.

Functions

external

  • external<T>(): object
  • Utility function to create new observables from external sources. Returns an object with two values: the new observable, and a next function which will emit a value to observable when called. Calling next with EOF will indicate there are no more values to emit.

    Type parameters

    • T

      Type of items to be emitted by the observable.

    Returns object

    • next: function
        • (v: T | unique symbol): void
        • Parameters

          • v: T | unique symbol

          Returns void

    • observable: ReadableStream<T>

Generated using TypeDoc