Class IoCapabilitiesBeta

Readonly BetaacceptsAny

Readonly BetaisConduit

Readonly BetaonlyAllowsConduitConnections

categories

• get categories(): string[]
  Beta

  The accepted category IDs. This is an empty array if IoCapabilities.acceptsAny is true.

  Returns string[]

types

• get types(): string[]
  Beta

  The accepted type IDs. This is an empty array if IoCapabilities.acceptsAny is true.

  Returns string[]

acceptsAnyTypeOfCategory

• acceptsAnyTypeOfCategory(
      category: string,
      isFromConduit?: boolean,
  ): Promise<boolean>
  Beta

  Check if this object accepts any storage type of the given category, implicitly or explicitly.

  Parameters

  • category: string

    The category to check.

  • isFromConduit: boolean = false

    Is the source a conduit?

  Returns Promise<boolean>

  Whether this object accepts any storage type of the given category.

  Remarks

  This returns true if any of the following conditions are true:

  • IoCapabilities.acceptsAny is true.
  • Accepted categories includes the given category.
  • Any accepted type is of the given category.

  Throws

  Throws a PublicError of type PublicErrorType.InvalidState if this package has not been initialized (see init).

acceptsCategory

• acceptsCategory(category: string, isFromConduit?: boolean): boolean
  Beta

  Check if this object accepts the given category, implicitly or explicitly.

  Parameters

  • category: string

    The category to check.

  • isFromConduit: boolean = false

    Is the source a conduit?

  Returns boolean

  Whether this object accepts the given category.

  Remarks

  This returns true if any of the following conditions are true:

  • IoCapabilities.acceptsAny is true.
  • Accepted categories includes the given category.

acceptsTypeData

• acceptsTypeData(storageType: StorageTypeData, isFromConduit?: boolean): boolean
  Beta

  Check if this object accepts the given storage type data, implicitly or explicitly. Use IoCapabilities.acceptsTypeId to check by ID.

  Parameters

  • storageType: StorageTypeData

    The storage type data to check.

  • isFromConduit: boolean = false

    Is the source a conduit?

  Returns boolean

  Whether this object accepts the given storage type.

  Remarks

  This returns true if any of the following conditions are true:

  • IoCapabilities.acceptsAny is true.
  • Accepted categories includes the category of the storage type.
  • Accepted types includes the storage type.

acceptsTypeId

• acceptsTypeId(id: string, isFromConduit?: boolean): Promise<boolean>
  Beta

  Get a storage type by it's ID and check if this object accepts it, implicitly or explicitly.

  Parameters

  • id: string

    The ID of the storage type.

  • isFromConduit: boolean = false

    Is the source a conduit?

  Returns Promise<boolean>

  Whether this object accepts the storage type with the given ID.

  Remarks

  This returns true if any of the following conditions are true:

  • IoCapabilities.acceptsAny is true.
  • Accepted categories includes the category of the storage type.
  • Accepted types includes the storage type.

  Throws

  Throws a PublicError of type PublicErrorType.InvalidState if this package has not been initialized (see init).

acceptsTypeIdExplicit

• acceptsTypeIdExplicit(id: string, isFromConduit?: boolean): boolean
  Beta

  Check if this object accepts the given storage type explicitly or accepts any.

  Parameters

  • id: string

    The ID of the storage type.

  • isFromConduit: boolean = false

    Is the source a conduit?

  Returns boolean

  Whether this object accepts the storage type with the given ID.

  Remarks

  This returns true if any of the following conditions are true:

  • IoCapabilities.acceptsAny is true.
  • Accepted types includes the storage type.

canConnectTo

• canConnectTo(other: IoCapabilities): Promise<boolean>
  Beta

  Check if this object can connect to another IoCapabilities object.

  Parameters

  • other: IoCapabilities

    The other IoCapabilities object.

  Returns Promise<boolean>

  Whether the two objects can connect or not.

  Throws

  Throws a PublicError of type PublicErrorType.InvalidState if this package has not been initialized (see init).

Staticaccepting

• accepting(
      types: string[],
      categories: string[],
      options?: NewIoCapabilitiesOptions,
  ): IoCapabilities
  Beta

  Create a new IoCapabilities object that accepts the given types and categories.

  Parameters

  • types: string[]

    Accepted type IDs.

  • categories: string[]

    Accepted categories.

  • Optionaloptions: NewIoCapabilitiesOptions

    Additional options.

  Returns IoCapabilities

  Returns a new IoCapabilities object.

StaticacceptingAny

• acceptingAny(options?: NewIoCapabilitiesOptions): IoCapabilities
  Beta

  Create a new IoCapabilities object that accepts any type or category.

  Parameters

  • Optionaloptions: NewIoCapabilitiesOptions

    Additional options.

  Returns IoCapabilities

  Returns a new IoCapabilities object.

StaticfromBlock

• fromBlock(block: Block, side: Direction | "network_link"): IoCapabilities
  Beta

  Get the input/output capabilities of a block.

  Parameters

  • block: Block

    The block.

  • side: Direction | "network_link"

    The side of the machine to check or "network_link" for linked connections.

  Returns IoCapabilities

  A new IoCapabilities object.