StartsWith

StartsWith( value, search )
StartsWith( value, search )
StartsWith( value, search )
StartsWith( value, search )
starts_with( value, search )
StartsWith( value, search )

Description

The StartsWith function returns true when the value string starts with the search string, or false when it does not.

Parameters

Argument Type Definition and Requirements

value

String

The string to compare.

search

String

The string to search for at the start of value.

Returns

Returns a boolean: true when value starts with search, or false when it does not.

Examples

The following query demonstrates the case where the value string starts with the search string:

Value result = await client.Query(
  StartsWith("Fauna", "F")
);

IResult<Value> data = result.To<Value>();
data.Match(
  Success: value => Console.WriteLine($"{value}"),
  Failure: error => Console.WriteLine($"Query failed:\n{error}")
);
BooleanV(True)
result, err := client.Query(
  f.StartsWith("Fauna", "F"))

if (err != nil) {
  fmt.Println(err)
} else {
  fmt.Println(result)
}
true
System.out.println(
    client.query(
        StartsWith("Fauna", "F")
    ).get()
);
true
client.query(
  q.StartsWith('Fauna', 'F')
)
.then((ret) => console.log(ret))
true
print(client.query(
  q.starts_with("Fauna", "F")
))
True
println(Await.result(
  client.query(
    StartsWith("Fauna", "F"),
  ),
  5.seconds
))
true

The following query demonstrates the case where the value string does not start with the search string:

Value result = await client.Query(
  StartsWith("Fauna", "f")
);

IResult<Value> data = result.To<Value>();
data.Match(
  Success: value => Console.WriteLine($"{value}"),
  Failure: error => Console.WriteLine($"Query failed:\n{error}")
);
BooleanV(False)
result, err := client.Query(
  f.StartsWith("Fauna", "f"))

if (err != nil) {
  fmt.Println(err)
} else {
  fmt.Println(result)
}
false
System.out.println(
    client.query(
        StartsWith("Fauna", "f")
    ).get()
);
false
client.query(
  q.StartsWith('Fauna', 'f')
)
.then((ret) => console.log(ret))
false
print(client.query(
  q.starts_with("Fauna", "f")
))
False
println(Await.result(
  client.query(
    StartsWith("Fauna", "f"),
  ),
  5.seconds
))
false

Is this article helpful? 

Tell Fauna how the article can be improved:
 Visit Fauna's forums or email docs@fauna.com

Thank you for your feedback!