ATProtoKit icon indicating copy to clipboard operation
ATProtoKit copied to clipboard

[Documentation]: Write documentation on getting a record with the `getRecord()` method

Open MasterJ93 opened this issue 1 year ago • 0 comments

Summary

An article needs to be written on how to get a record with one line, as well as how to handle the ATUnion type.

Description

For version 0.15.0, a new feature will be added: the getRecord() method within the UnknownType enum. This allows developers to get the record of an output without the need to explicitly use pattern matching, as this is already done within the method itself. Therefore, an article needs to be made in order to help developers know how to get records from an output without needing to use pattern matching, thereby making things less verbose to see.

Furthermore, an addition article needs to be made on how to handle the ATUnion type in outputs. Unlike records, union types do require pattern matching, so developers will need to understand how to handle this.

What type of issue is it?

Other

ATProtoKit Version

0.14.0

Documentation Location

N/A

Additional Context

Tasks:

  • [x] Create an article on how to get a record with one line.
    • Named "Retrieving Records with getRecord()".
  • [ ] Create an article on how to access an ATUnion struct.
    • Named "Accessing Union Types With Pattern Matching".

MasterJ93 avatar Jun 30 '24 06:06 MasterJ93