Interface ISparseFieldSetParser

Namespace

JsonApiDotNetCore.Queries.Parsing

Assembly

JsonApiDotNetCore.dll

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

public interface ISparseFieldSetParser

Methods

Parse(string, ResourceType)

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

SparseFieldSetExpression? 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

SparseFieldSetExpression