Coda by Ian Macalinao
    Preparing search index...

    Function setStructFieldDocsVisitor

    • Creates a visitor that injects docs onto individual struct fields.

      Codama's built-in updateInstructionsVisitor and updateDefinedTypesVisitor can set docs on instructions, instruction accounts, instruction arguments and whole defined types, but they cannot reach the individual fields of a struct. This visitor fills that gap so that account data fields and the fields of instruction argument structs can be documented.

      Parameters

      Returns Visitor<
          Node
          | null,

              | "accountNode"
              | "constantNode"
              | "definedTypeNode"
              | "errorNode"
              | "eventNode"
              | "instructionAccountNode"
              | "instructionArgumentNode"
              | "instructionByteDeltaNode"
              | "instructionNode"
              | "instructionRemainingAccountsNode"
              | "instructionStatusNode"
              | "pdaNode"
              | "programNode"
              | "pdaSeedValueNode"
              | "accountBumpValueNode"
              | "accountValueNode"
              | "argumentValueNode"
              | "conditionalValueNode"
              | "identityValueNode"
              | "payerValueNode"
              | "pdaValueNode"
              | "programIdValueNode"
              | "resolverValueNode"
              | "fixedCountNode"
              | "prefixedCountNode"
              | "remainderCountNode"
              | "constantDiscriminatorNode"
              | "fieldDiscriminatorNode"
              | "sizeDiscriminatorNode"
              | "accountLinkNode"
              | "definedTypeLinkNode"
              | "instructionAccountLinkNode"
              | "instructionArgumentLinkNode"
              | "instructionLinkNode"
              | "pdaLinkNode"
              | "programLinkNode"
              | "constantPdaSeedNode"
              | "variablePdaSeedNode"
              | "enumEmptyVariantTypeNode"
              | "enumStructVariantTypeNode"
              | "enumTupleVariantTypeNode"
              | "amountTypeNode"
              | "arrayTypeNode"
              | "booleanTypeNode"
              | "bytesTypeNode"
              | "dateTimeTypeNode"
              | "enumTypeNode"
              | "fixedSizeTypeNode"
              | "hiddenPrefixTypeNode"
              | "hiddenSuffixTypeNode"
              | "mapTypeNode"
              | "numberTypeNode"
              | "optionTypeNode"
              | "postOffsetTypeNode"
              | "preOffsetTypeNode"
              | "publicKeyTypeNode"
              | "remainderOptionTypeNode"
              | "sentinelTypeNode"
              | "setTypeNode"
              | "sizePrefixTypeNode"
              | "solAmountTypeNode"
              | "stringTypeNode"
              | "structTypeNode"
              | "tupleTypeNode"
              | "zeroableOptionTypeNode"
              | "structFieldTypeNode"
              | "mapEntryValueNode"
              | "arrayValueNode"
              | "booleanValueNode"
              | "bytesValueNode"
              | "constantValueNode"
              | "enumValueNode"
              | "mapValueNode"
              | "noneValueNode"
              | "numberValueNode"
              | "publicKeyValueNode"
              | "setValueNode"
              | "someValueNode"
              | "stringValueNode"
              | "structValueNode"
              | "tupleValueNode"
              | "structFieldValueNode"
              | "rootNode",
      >

      A bottom-up transformer visitor that sets the field docs.

      setStructFieldDocsVisitor({
        createV1Args: {
          name: "The name of the asset.",
          uri: "The URI pointing to the asset's off-chain JSON metadata.",
        },
      });

    Settings

    Member Visibility