Skip to content

Commit

Permalink
docs(InteractionOutput): improve interface documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
JKRhb committed Jan 27, 2024
1 parent c04303d commit 57a303b
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions lib/src/core/scripting_api/interaction_output.dart
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,19 @@ abstract interface class InteractionOutput {

/// Asyncronously creates a [ByteBuffer] representation of the value of
/// of the [InteractionOutput].
///
/// Follows the algorithm defined for the `arrayBuffer()` function in the
/// Scripting API specification.
///
/// [algorithm]: https://w3c.github.io/wot-scripting-api/#the-arraybuffer-function
Future<ByteBuffer> arrayBuffer();

/// The parsed value of the [InteractionOutput].
///
///
/// Follows the algorithm defined for the `arrayBuffer()` function in the
/// Scripting API specification.
///
/// [algorithm]: https://w3c.github.io/wot-scripting-api/#the-value-function
Future<Object?> value();
}

0 comments on commit 57a303b

Please sign in to comment.