From dae7d6e40cd3d87ed4a44deadaad51d0a0dd7f58 Mon Sep 17 00:00:00 2001 From: LuanRT Date: Wed, 15 Mar 2023 04:12:21 -0300 Subject: [PATCH] chore: update parser docs to reflect latest changes --- src/parser/README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/src/parser/README.md b/src/parser/README.md index ec161ebb..00fba3d1 100644 --- a/src/parser/README.md +++ b/src/parser/README.md @@ -20,6 +20,7 @@ The parser is responsible for sanitizing and standardizing InnerTube responses w - [Accessing properties without casting](#accessing-properties-without-casting) - [Memo](#memo) - [Adding new nodes](#adding-new-nodes) + - [Generating nodes at runtime](#generating-nodes-at-runtime) - [How it works](#how-it-works) ## Structure @@ -27,9 +28,11 @@ The parser is responsible for sanitizing and standardizing InnerTube responses w * [`/types`](https://github.com/LuanRT/YouTube.js/blob/main/src/parser/types) - General response types. * [`/classes`](https://github.com/LuanRT/YouTube.js/blob/main/src/parser/classes) - InnerTube nodes. +* [`generator.ts`](https://github.com/LuanRT/YouTube.js/blob/main/src/parser/generator.ts) - Used to generate missing nodes at runtime. * [`helpers.ts`](https://github.com/LuanRT/YouTube.js/blob/main/src/parser/helpers.ts) - Helper functions/classes for the parser. * [`parser.ts`](https://github.com/LuanRT/YouTube.js/blob/main/src/parser/parser.ts) - The core of the parser. -* [`map.ts`](https://github.com/LuanRT/YouTube.js/blob/main/src/parser/map.ts) - Contains a list of all the InnerTube nodes, which is used to determine the appropriate node for a given renderer. It's important to note that this file is automatically generated and should not be edited manually. +* [`nodes.ts`](https://github.com/LuanRT/YouTube.js/blob/main/src/parser/node.ts) - Contains a list of all the InnerTube nodes, which is used to determine the appropriate node for a given renderer. It's important to note that this file is automatically generated and should not be edited manually. +* [`misc.ts`](https://github.com/LuanRT/YouTube.js/blob/main/src/parser/misc.ts) - Miscellaneous classes for. Also automatically generated. ### Clients