Merge pull request #12 from hammzj/dev/make-protected

Dev/make protected

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hammzj/cypress-page-object",
-  "version": "2.0.3",
+  "version": "2.0.4",
   "description": "A set of template classes and guides to help with developing component and page objects in Cypress.",
   "author": "Zachary Hamm <[email protected]>",
   "license": "MIT",

src/page.object.ts

@@ -22,8 +22,8 @@ class InsufficientPathVariablesError extends Error {
  * object, or both.
  */
 export default class PageObject extends ElementCollection {
-    static #PATH_REPLACEMENT_REGEX = /(?<pathVariable>:\w+)/g;
-    public metadata: IPageMetadata;
+    static readonly #PATH_REPLACEMENT_REGEX = /(?<pathVariable>:\w+)/g;
+    protected metadata: IPageMetadata;
 
     /**
      * @example new PageObject(); //Index page

src/types/page.object.ts

@@ -1,7 +1,12 @@
 import { IMetadata } from "./element.collection";
 
+/**
+ * [title=] {string} Page title
+ * [title=] {string} If not provided, the baseUrl from the Cypress config is used from `Cypress.config().baseUrl
+ * [path=""] {string} Path to append to baseUrl. Can use dynamic path replacements like `/token/:someId`
+ */
 export interface IPageMetadata extends IMetadata {
     title?: string;
-    baseUrl?: string; //If not provided, the baseUrl from the Cypress config is used
+    baseUrl?: string;
     path: string | "";
 }