Interface MlStringVariants
interface MlStringVariants { buildMultiLanguageQuery( fieldName: string, searchTerm: string, operator?: string, ): string; buildQuery( fieldName: string, lang: string, value: string, operator?: string, ): string; getHTMLSchema(options?: MlStringHTMLSchemaOptions): ObjectType<string>; getRichTextSchema(): ObjectType<MultilingualRichText>; getSafeTextSchema( options: MlStringPlainTextSchemaOptions & { array: true }, ): ObjectType<string[]>; getSafeTextSchema( options?: MlStringPlainTextSchemaOptions, ): ObjectType<string>; getSchema( options: MlStringSchemaOptions & { array: true }, ): ObjectType<string[]>; getSchema( options?: MlStringSchemaOptions & { array?: false }, ): ObjectType<string>; getSchema(options?: MlStringSchemaOptions): ObjectType<string>; getValidLanguageKeys(): string[]; isValidLanguageKey(langKey: string): boolean; resolve(lang: string, strObj: Record<string, string>): ResolveResult; stripHTML<T extends MultilingualInput>(strObj: T): T; stripHTMLFromArray<T extends MultilingualInput>(strObjArr: T[]): T[]; stripHTMLFromArrayValues( strObj: MultilingualStringArray, ): MultilingualStringArray; validate(value: unknown, options?: MlStringSchemaOptions): boolean;} Methods
buildMultiLanguageQuery
buildMultiLanguageQuery( fieldName: string, searchTerm: string, operator?: string,): string Parameters
- fieldName: string
- searchTerm: string
Optionaloperator: string
Returns string
buildQuery
buildQuery( fieldName: string, lang: string, value: string, operator?: string,): string Parameters
- fieldName: string
- lang: string
- value: string
Optionaloperator: string
Returns string
getValidLanguageKeys
getValidLanguageKeys(): string[]
isValidLanguageKey
isValidLanguageKey(langKey: string): boolean
resolve
resolve(lang: string, strObj: Record<string, string>): ResolveResult Parameters
- lang: string
- strObj: Record<string, string>
stripHTMLFromArrayValues
stripHTMLFromArrayValues( strObj: MultilingualStringArray,): MultilingualStringArray Parameters
- strObj: MultilingualStringArray
Returns MultilingualStringArray
Interface providing overloaded signatures for mlString schema methods. Enables proper type inference based on the
arrayoption.