Function shouldIncludeProperty

  • shouldIncludeProperty<T = any>(
        propertyName: string,
        propSchema: JSONSchema7,
        filterOptions: GraphTraversalFilterOptions<T>,
    ): { include: boolean; pagination?: PaginationOptions }

    Checks if a property should be included based on filter options

    Type Parameters

    • T = any

      The type to derive filter patterns from

    Parameters

    • propertyName: string

      The name of the property

    • propSchema: JSONSchema7

      The property schema

    • filterOptions: GraphTraversalFilterOptions<T>

      The filter options to apply

    Returns { include: boolean; pagination?: PaginationOptions }

    Object with inclusion status and pagination options

Settings

Member Visibility