Should-MatchString

This page was generated

Contributions are welcome in Pester-repo.

SYNOPSIS

Tests whether a string matches a regular expression pattern.

SYNTAX

Should-MatchString [-Expected] <Object> [[-Actual] <Object>] [-CaseSensitive] [-Because <string>]

DESCRIPTION

The Should-MatchString assertion compares the actual string to the expected regular expression pattern using the -match operator. The -match operator is case-insensitive by default, but you can make it case-sensitive by using the -CaseSensitive switch.

EXAMPLES

EXAMPLE 1

(New-Guid).Guid | Should-MatchString '^[0-9a-f-]{36}$'

This assertion passes, because a GUID is made up of 36 lowercase hexadecimal and dash characters.

EXAMPLE 2

'user-4f2a' | Should-MatchString '^user-[0-9a-f]{4}$'

This assertion passes, because the generated id matches the expected user- prefix followed by four hexadecimal characters. This is handy for checking that a function returns ids, tokens or file names in the format you expect.

EXAMPLE 3

'Pester 6.0.0' | Should-MatchString 'pester \d+\.\d+\.\d+' -CaseSensitive

This assertion fails, because with -CaseSensitive the lowercase pester in the pattern does not match the capitalized Pester in the actual value.

PARAMETERS

-Actual

The actual value.

Type: System.Object
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: 1
  IsRequired: false
  ValueFromPipeline: true
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-Because

The reason why the actual value should match the regular expression pattern.

Type: System.String
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets: