Class: Filter

EventStore.Client.Messages.Filter(propertiesopt)

Represents a Filter.

Constructor

new Filter(propertiesopt)

Constructs a new Filter.
Parameters:
Name Type Attributes Description
properties EventStore.Client.Messages.IFilter <optional>
 Properties to set
Implements:
  • IFilter
Source:

Members

context :EventStore.Client.Messages.Filter.FilterContext

Filter context.
Type:
Source:

data :Array.<string>

Filter data.
Type:
  • Array.<string>
Source:

type :EventStore.Client.Messages.Filter.FilterType

Filter type.
Type:
Source:

(static) FilterContext :number

FilterContext enum.
Type:
  • number
Properties:
Name Type Description
StreamId number StreamId value
EventType number EventType value
Source:

(static) FilterType :number

FilterType enum.
Type:
  • number
Properties:
Name Type Description
Regex number Regex value
Prefix number Prefix value
Source:

Methods

toJSON() → {Object.<string, *>}

Converts this Filter to JSON.
Source:
Returns:
JSON object
Type
Object.<string, *>

(static) create(propertiesopt) → {EventStore.Client.Messages.Filter}

Creates a new Filter instance using the specified properties.
Parameters:
Name Type Attributes Description
properties EventStore.Client.Messages.IFilter <optional>
 Properties to set
Source:
Returns:
Filter instance
Type
EventStore.Client.Messages.Filter

(static) decode(reader, lengthopt) → {EventStore.Client.Messages.Filter}

Decodes a Filter message from the specified reader or buffer.
Parameters:
Name Type Attributes Description
reader $protobuf.Reader | Uint8Array Reader or buffer to decode from
length number <optional>
 Message length if known beforehand
Source:
Throws:
  • If the payload is not a reader or valid buffer
    Type
    Error
  • If required fields are missing
    Type
    $protobuf.util.ProtocolError
Returns:
Filter
Type
EventStore.Client.Messages.Filter

(static) decodeDelimited(reader) → {EventStore.Client.Messages.Filter}

Decodes a Filter message from the specified reader or buffer, length delimited.
Parameters:
Name Type Description
reader $protobuf.Reader | Uint8Array Reader or buffer to decode from
Source:
Throws:
  • If the payload is not a reader or valid buffer
    Type
    Error
  • If required fields are missing
    Type
    $protobuf.util.ProtocolError
Returns:
Filter
Type
EventStore.Client.Messages.Filter

(static) encode(message, writeropt) → {$protobuf.Writer}

Encodes the specified Filter message. Does not implicitly verify messages.
Parameters:
Name Type Attributes Description
message EventStore.Client.Messages.IFilter Filter message or plain object to encode
writer $protobuf.Writer <optional>
 Writer to encode to
Source:
Returns:
Writer
Type
$protobuf.Writer

(static) encodeDelimited(message, writeropt) → {$protobuf.Writer}

Encodes the specified Filter message, length delimited. Does not implicitly verify messages.
Parameters:
Name Type Attributes Description
message EventStore.Client.Messages.IFilter Filter message or plain object to encode
writer $protobuf.Writer <optional>
 Writer to encode to
Source:
Returns:
Writer
Type
$protobuf.Writer

(static) fromObject(object) → {EventStore.Client.Messages.Filter}

Creates a Filter message from a plain object. Also converts values to their respective internal types.
Parameters:
Name Type Description
object Object.<string, *> Plain object
Source:
Returns:
Filter
Type
EventStore.Client.Messages.Filter

(static) getTypeUrl(typeUrlPrefixopt) → {string}

Gets the default type url for Filter
Parameters:
Name Type Attributes Description
typeUrlPrefix string <optional>
 your custom typeUrlPrefix(default "type.googleapis.com")
Source:
Returns:
The default type url
Type
string

(static) toObject(message, optionsopt) → {Object.<string, *>}

Creates a plain object from a Filter message. Also converts values to other types if specified.
Parameters:
Name Type Attributes Description
message EventStore.Client.Messages.Filter Filter
options $protobuf.IConversionOptions <optional>
 Conversion options
Source:
Returns:
Plain object
Type
Object.<string, *>

(static) verify(message) → {string|null}

Verifies a Filter message.
Parameters:
Name Type Description
message Object.<string, *> Plain object to verify
Source:
Returns:
`null` if valid, otherwise the reason why it is not
Type
string | null