Update packages/timeline-state-resolver-types/src/index.ts

Co-authored-by: Johan Nyman <[email protected]>
nrkno · Aug 19, 2024 · 34dcf3a · 34dcf3a
1 parent 9406a73
commit 34dcf3a
Showing 1 changed file with 4 additions and 1 deletion.
diff --git a/packages/timeline-state-resolver-types/src/index.ts b/packages/timeline-state-resolver-types/src/index.ts
@@ -173,8 +173,11 @@ export enum ActionExecutionResultCode {
 	Ok = 'OK',
 }
 
-export interface StringInterpolation {
+/** This resolves to a string, where parts can be defined by the datastore */
+export interface TemplateString{
+	/** The string template. Example: "http://google.com?q={{searchString}}" */
 	key: string
+	/** Values for the arguments in the key string. Example: { searchString: "TSR" } */
 	args?: {
 		[k: string]: any
 	}