Documentation
Interface: DocReadTime
Description: This interface defines the structure for storing information about the reading time of a document. It includes properties for the number of minutes, words, and the text of the document.
Properties
Property: minutes
Type: number
Description:
The number of minutes it takes to read the document.
Property: words
Type: number
Description:
The number of words in the document.
Property: text
Type: string
Description:
The text content of the document.
==========
Interface: DocUsage
Description: This interface defines the structure for storing information about how a code snippet is used. It includes properties for the code itself, a description of its use, and the language of the code.
Properties
Property: code
Type: string
Description:
The code snippet itself.
Property: description
Type: string
Description:
A description of how the code snippet is used.
Property: language
Type: string
Description:
The programming language of the code snippet.
==========
Type: TypePattern
Description: This type represents a type pattern, which is a combination of a full type string and a pattern object. It is used to define more complex data structures.
Properties
Property: full
Type: string
Description:
The full type string.
Property: pattern
Type: object
Description:
The pattern object, which defines the structure of the data.
==========
Interface: DocParams
Description: This interface defines the structure for storing information about a function or method parameter. It includes properties for the parameter name, type name, description, default value, and whether it is optional.
Properties
Property: name
Type: string
Description:
The name of the parameter.
Property: type_name
Type: string | TypePattern
Description:
The type name of the parameter. It can be a simple string or a TypePattern.
Property: description
Type: string
Description:
A description of the parameter.
Property: default_value
Type: string
Description:
The default value of the parameter, if any.
Property: optional
Type: boolean
Description:
Indicates whether the parameter is optional.
==========
Interface: DocReturns
Description: This interface defines the structure for storing information about the return value of a function or method. It includes properties for the return type name and a description of the return value.
Properties
Property: type_name
Type: string | TypePattern
Description:
The type name of the return value. It can be a simple string or a TypePattern.
Property: description
Type: string
Description:
A description of the return value.
==========
Interface: DocEntity
Description: This interface defines the structure for storing information about a code entity, such as a function, method, class, or variable. It includes properties for the entity name, type name, description, whether it is a complex type, its parameters, return value, and usage information.
Properties
Property: name
Type: string
Description:
The name of the code entity.
Property: type_name
Type: string
Description:
The type name of the code entity.
Property: description
Type: string
Description:
A description of the code entity.
Property: complex_type
Type: boolean
Description:
Indicates whether the code entity represents a complex type, such as an object or an interface.
Property: params
Type: DocParams[]
Description:
An array of DocParams objects representing the parameters of the code entity.
Property: returns
Type: DocReturns
Description:
A DocReturns object representing the return value of the code entity.
Property: usage
Type: DocUsage
Description:
A DocUsage object containing usage information about the code entity.
==========
Interface: DocItem
Description: This interface defines the structure for storing information about a code item, which can be a function, method, class, interface, or any other code element. It includes properties for the item's ID, name, type, description, ancestors, interfaces, superclass, and details about its constructors, attributes, fields, methods, parameters, return value, yield, and usage.
Properties
Property: id
Type: string
Description:
A unique identifier for the code item.
Property: name
Type: string
Description:
The name of the code item.
Property: item_type
Type: string
Description:
The type of the code item, such as "function", "method", "class", or "interface".
Property: description
Type: string
Description:
A description of the code item.
Property: ancestors
Type: Array<string>
Description:
An array of strings representing the ancestors of the code item in the code hierarchy.
Property: interfaces
Type: Array<string>
Description:
An array of strings representing the interfaces implemented by the code item.
Property: superclass
Type: string
Description:
The name of the superclass of the code item, if any.
Property: constructors
Type: DocEntity[]
Description:
An array of DocEntity objects representing the constructors of the code item, if any. This property is optional.
Property: attributes
Type: DocEntity[]
Description:
An array of DocEntity objects representing the attributes of the code item, if any. This property is optional.
Property: fields
Type: DocEntity[]
Description:
An array of DocEntity objects representing the fields of the code item, if any. This property is optional.
Property: methods
Type: DocEntity[]
Description:
An array of DocEntity objects representing the methods of the code item, if any. This property is optional.
Property: params
Type: DocEntity[]
Description:
An array of DocEntity objects representing the parameters of the code item, if any. This property is optional.
Property: returns
Type: DocEntity
Description:
A DocEntity object representing the return value of the code item, if any. This property is optional.
Property: yields
Type: DocEntity
Description:
A DocEntity object representing the yield value of the code item, if any. This property is optional.
Property: usage
Type: DocUsage
Description:
A DocUsage object containing usage information about the code item. This property is optional.
==========
Interface: DocContent
Description:
This interface defines the structure for storing the content of a document. It includes a structured property which represents the content in a structured format.
Properties
Property: structured
Type: object
Description:
An object containing the structured content of the document. It includes properties for description, diagram, and items.
Properties of structured:
description: A string or an object withdocandusageproperties, both strings.diagram: An object with properties representing different diagram types:mermaid,archd2,gviz, andd2, each with a string value or an object containing thesrcproperty.items: An array ofDocItemobjects representing the individual code items within the document.
==========
Interface: DocumentProps
Description: This interface defines the structure for storing properties of a document, including information about the repository, branch, and the document itself.
Properties
Property: repo
Type: object
Description:
An object containing information about the repository where the document is located. It includes the html_url property, which is a string representing the URL of the repository on GitHub. Additionally, it can contain other key-value pairs.
Properties of repo:
html_url: A string representing the URL of the repository on GitHub.[key: string]: any: Allows for additional key-value pairs to be included in the object.
Property: branch
Type: object
Description:
An object containing information about the branch where the document is located. It includes the name property, which is a string representing the name of the branch. Additionally, it can contain other key-value pairs.
Properties of branch:
name: A string representing the name of the branch.[key: string]: any: Allows for additional key-value pairs to be included in the object.
Property: doc
Type: object
Description:
An object containing information about the document itself. It includes properties for the document's name, path, content, status, state, and running status.
Properties of doc:
name: A string representing the name of the document.path: A string representing the path to the document within the repository.content: ADocContentobject representing the content of the document.status: An optional property of any type, indicating the status of the document.state: An optionalDocStateobject representing the current state of the document.running: An optional boolean value, indicating whether the document is currently running.
==========