FAIRsharing.org

Classes

Classes

ExternalRESTClients
GraphQLClient
RESTClient

Namespaces

Static

Members

<constant> buildFacets

Given an object containing the raw facets coming from the client and a mapping object , build the ready to use facets for usage by the Vue components.

Source:

<constant> buildFilters

Given a searchFairsharingRecords aggregations array, build the values used by the advanced search widgets

Source:

filtersStore :Object

The searchFilters store trigger a single field query to searchFairsharingRecords, gets the aggregation array and builds the filtering system to be used by advanced search functions.

Type:
  • Object
Source:

introspectionStore :Object

The introspection store is related to the introspection query that let us know which fields/types are allowed by the searchFairsharingRecords query

Type:
  • Object
Source:

<constant> paramsAreExpired

Compares the given date with now and returns true if it greater than the given timer

Source:

recordStore :Object

The record store handles the requests related to record (fairsharingRecord).

Type:
  • Object
Source:

<constant> recordTypes

Mixin to filter the records types based on the registry {{computed: {getRecordTypes: Computed}, methods: {filteredRecordTypes(*): *[]}}}

Source:

recordsStore :Object

The records store handles the requests related to records (searchFairsharingRecords and fairsharingRecord).

Type:
  • Object
Source:

states :Object

Type:
  • Object
Properties:
Name Type Description
errors String

collects errors while introspecting.
searchQueryParameters object

filters query parameters object coming from API.
Source:

Methods

hackSearch()

Convert a prop from the old system into that used by the new. Useful when old search links have been deployed elsewhere in the internet or in print (as long as we know about them).

Source:
Returns:

String - new form of the old prop

hasValue(val)

Assess if the string is of a certain value (useful to compare passwords)

Parameters:
Name Type Description
val String

the value to evaluate the string against
Source:
Returns:
Type
function

isAllowedSize()

Assess if the given file has the correct allowed size

Source:
Returns:
Type
function

isEmail()

Assess email patterns.

Source:
Returns:
Type
function

isEmailOrUrl()

Assess email or email patterns.

Source:
Returns:
Type
function

isImage()

Assess if the given file has the correct extension

Source:
Returns:
Type
function

isLongEnough(length)

Assess if the string is long enough.

Parameters:
Name Type Description
length Number

the length to evaluate the string against.
Source:
Returns:
Type
function

isMastodon()

Assess mastodon username @user@server.

Source:
Returns:
Type
function

isOrcid()

Assess ORCID patterns. Can be empty if required is false.

Source:
Returns:
Type
function

isRequired()

Assess the presence of the field

Source:
Returns:
Type
function

isUrl()

Assess URL patterns.

Source:
Returns:
Type
function

parseParam(param, paramVal)

Given a type and a value, parse the value with the expected type.

Parameters:
Name Type Description
param Object

the parameter types allowed
paramVal String

the value to be parsed
Source:
Returns:

paramVal - the parse value

Type
String | Number | Boolean
Example

Example usage of parseParam 

parseParam({name: "Boolean"}, "true");
 // return True

removeItem(item, arrayList)

Removes an item from the array

Parameters:
Name Type Description
item
arrayList
Source:
Returns:
  • updated array without the item
Type
Array

uniqueValues()

Removes duplicate values in a set and returns unique values

Source:
Returns:

Array with non-duplicate values

Type
Array