docs(en): adding addStatement documentation

roggervalf · Dec 5, 2020 · 0fca966 · 0fca966
1 parent f9681e6
commit 0fca966
Show file tree

Hide file tree

Showing 6 changed files with 77 additions and 2 deletions.
diff --git a/dist/main.d.ts b/dist/main.d.ts
@@ -210,6 +210,7 @@ declare class ActionBasedPolicy<T extends object> extends Policy<T, ActionBasedT
     private allowStatements;
     private statements;
     constructor({ statements, conditionResolver, context }: ActionBasedPolicyInterface<T>);
+    addStatement(this: ActionBasedPolicy<T>, statement: ActionBasedType): void;
     getStatements(this: ActionBasedPolicy<T>): ActionBasedType[];
     evaluate(this: ActionBasedPolicy<T>, { action, context }: EvaluateActionBasedInterface<T>): boolean;
     can(this: ActionBasedPolicy<T>, { action, context }: EvaluateActionBasedInterface<T>): boolean;
@@ -227,6 +228,7 @@ declare class IdentityBasedPolicy<T extends object> extends Policy<T, IdentityBa
     private allowStatements;
     private statements;
     constructor({ statements, conditionResolver, context }: IdentityBasedPolicyInterface<T>);
+    addStatement(this: IdentityBasedPolicy<T>, statement: IdentityBasedType): void;
     getStatements(this: IdentityBasedPolicy<T>): IdentityBasedType[];
     evaluate(this: IdentityBasedPolicy<T>, { action, resource, context }: EvaluateIdentityBasedInterface<T>): boolean;
     can(this: IdentityBasedPolicy<T>, { action, resource, context }: EvaluateIdentityBasedInterface<T>): boolean;
@@ -243,6 +245,7 @@ declare class ResourceBasedPolicy<T extends object> extends Policy<T, ResourceBa
     private allowStatements;
     private statements;
     constructor({ statements, conditionResolver, context }: ResourceBasedPolicyInterface<T>);
+    addStatement(this: ResourceBasedPolicy<T>, statement: ResourceBasedType): void;
     getStatements(this: ResourceBasedPolicy<T>): ResourceBasedType[];
     evaluate(this: ResourceBasedPolicy<T>, { principal, action, resource, principalType, context }: EvaluateResourceBasedInterface<T>): boolean;
     can(this: ResourceBasedPolicy<T>, { principal, action, resource, principalType, context }: EvaluateResourceBasedInterface<T>): boolean;

diff --git a/dist/main.es.js b/dist/main.es.js
diff --git a/dist/main.es.js.map b/dist/main.es.js.map
diff --git a/dist/main.js b/dist/main.js
diff --git a/dist/main.js.map b/dist/main.js.map
diff --git a/www/src/docs/en.md b/www/src/docs/en.md
@@ -422,6 +422,10 @@ const actionBasedPolicy = new ActionBasedPolicy({
 
 ### Methods
 
+#### actionBasedPolicy.addStatement(statement)
+
+_public_: Add a new `statement` to this Policy.
+
 #### actionBasedPolicy.getStatements()
 
 _public_: Returns `statements[]` (statements array).
@@ -525,6 +529,10 @@ const identityBasedPolicy = new IdentityBasedPolicy({
 
 ### Methods
 
+#### identityBasedPolicy.addStatement(statement)
+
+_public_: Add a new `statement` to this Policy.
+
 #### identityBasedPolicy.getStatements()
 
 _public_: Returns `statements[]` (statements array).
@@ -617,6 +625,10 @@ const resourceBasedPolicy = new ResourceBasedPolicy({
 
 ### Methods
 
+#### resourceBasedPolicy.addStatement(statement)
+
+_public_: Add a new `statement` to this Policy.
+
 #### resourceBasedPolicy.getStatements()
 
 _public_: Returns `statements[]` (statements array).