Interface IPaginationParser

Namespace

JsonApiDotNetCore.Queries.Parsing

Assembly

JsonApiDotNetCore.dll

Parses the JSON:API 'page' query string parameter value.

public interface IPaginationParser

Methods

Parse(string, ResourceType)

Parses the specified source into a PaginationQueryStringValueExpression. Throws a QueryParseException if the input is invalid.

PaginationQueryStringValueExpression Parse(string source, ResourceType resourceType)

Parameters

source string

The source text to read from.

resourceType ResourceType

The resource type used to lookup JSON:API fields that are referenced in source.

Returns

PaginationQueryStringValueExpression

Remarks

Due to the syntax of the JSON:API pagination parameter, The returned PaginationQueryStringValueExpression is an intermediate value that gets converted into PaginationExpression by PaginationQueryStringParameterReader.