Skip to content

Commit

Permalink
updated jdoc
Browse files Browse the repository at this point in the history
  • Loading branch information
duart38 committed Mar 15, 2021
1 parent 88cc031 commit a1e154f
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion builder/STRING.ts
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,8 @@ class STR {
}

/**
* Executes run if the last check stack is true. updated the stored string if the method returns a string
* Executes run if the last check stack is true. updated the stored string if the method returns a string.
* Unlike adapt ( @see adapt ), this method will update the string based on the conditions specified before it
* @example STRING("test").contains("est").do((v)=>{...})
* @param run
* @returns
Expand All @@ -112,6 +113,7 @@ class STR {

/**
* Adapts the internal string into whatever the provided method returns.
* Unlike the do method, this method will always run regardless of the evaluation before it.
* @param run {(prev: string)=>string} method that adapts the string
*/
public adapt(run: (prev: string)=>string): this {
Expand Down

0 comments on commit a1e154f

Please sign in to comment.