isValidFieldMask
isValidFieldMask(
schema,fieldMask,strict?):fieldMask is FieldMask
Defined in: fieldmask.ts:151
Check if a field mask is valid for a given message descriptor.
The FieldMask spec does not allow for wildcards and repeated or map fields must be the last part
of the path. The final argument for this function is strict, which defaults to true. If strict
is true, the function will only allow field masks that are valid according to the spec. However,
the AIP Guidelines allow for wildcards in field masks. So, if you want to
allow wildcards, you can set strict to false. This will allow for field masks with standalone
wildcards or wildcards in repeated or map fields (i.e. '*', 'foo.*', 'foo.*.bar', etc.).
Parameters
Section titled “Parameters”schema
Section titled “schema”DescMessage
fieldMask
Section titled “fieldMask”FieldMask
strict?
Section titled “strict?”boolean = true
Returns
Section titled “Returns”fieldMask is FieldMask