Interface: IMockStore
Defined in: packages/mock/src/types.ts:84
Properties
schema
schema:
GraphQLSchema
Defined in: packages/mock/src/types.ts:85
Methods
get()
Call Signature
get<
KeyT,ReturnKeyT>(args):unknown
Defined in: packages/mock/src/types.ts:106
Get a field value from the store for the given type, key and field name — and optionally field arguments. If the field name is not given, a reference to the type will be returned.
If the the value for this field is not set, a value will be generated according to field return type and mock functions.
If the field’s output type is a ObjectType (or list of ObjectType),
it will return a Ref (or array of Ref), ie a reference to an entity
in the store.
Example:
store.get('Query', 'ROOT', 'viewer');
> { $ref: { key: 'abc-737dh-djdjd', typeName: 'User' } }
store.get('User', 'abc-737dh-djdjd', 'name')
> "Hello World"Type Parameters
KeyT
KeyT extends KeyTypeConstraints = string
ReturnKeyT
ReturnKeyT extends KeyTypeConstraints = string
Parameters
args
GetArgs<KeyT>
Returns
unknown
Call Signature
get<
KeyT,ReturnKeyT>(typeName,key,fieldNameOrFieldNames,fieldArgs?):unknown
Defined in: packages/mock/src/types.ts:112
Shorthand for get({typeName, key, fieldName, fieldArgs}).
Type Parameters
KeyT
KeyT extends KeyTypeConstraints = string
ReturnKeyT
ReturnKeyT extends KeyTypeConstraints = string
Parameters
typeName
string
key
KeyT
fieldNameOrFieldNames
string | string[]
fieldArgs?
string | {[argName: string]: any; }
Returns
unknown
Call Signature
get<
KeyT>(typeName,keyOrDefaultValue?,defaultValue?):unknown
Defined in: packages/mock/src/types.ts:121
Get a reference to the type.
Type Parameters
KeyT
KeyT extends KeyTypeConstraints = string
Parameters
typeName
string
keyOrDefaultValue?
KeyT | {[fieldName: string]: any; }
defaultValue?
Returns
unknown
Call Signature
get<
KeyT,ReturnKeyT>(ref,fieldNameOrFieldNames,fieldArgs?):unknown
Defined in: packages/mock/src/types.ts:133
Shorthand for get({typeName: ref.$ref.typeName, key: ref.$ref.key, fieldName, fieldArgs})
Type Parameters
KeyT
KeyT extends KeyTypeConstraints = string
ReturnKeyT
ReturnKeyT extends KeyTypeConstraints = string
Parameters
ref
Ref<KeyT>
fieldNameOrFieldNames
string | string[]
fieldArgs?
string | {[argName: string]: any; }
Returns
unknown
has()
has<
KeyT>(typeName,key):boolean
Defined in: packages/mock/src/types.ts:210
Checks if a mock is present in the store for the given typeName and key.
Type Parameters
KeyT
KeyT extends KeyTypeConstraints = string
Parameters
typeName
string
key
KeyT
Returns
boolean
reset()
reset():
void
Defined in: packages/mock/src/types.ts:215
Resets the mock store
Returns
void
set()
Call Signature
set<
KeyT>(args):void
Defined in: packages/mock/src/types.ts:169
Set a field value in the store for the given type, key and field name — and optionally field arguments.
If the the field return type is an ObjectType or a list of
ObjectType, you can set references to other entity as value:
// set the viewer name
store.set('User', 1, 'name', 'Alexandre);
store.set('Query', 'ROOT', 'viewer', store.get('User', 1));
// set the friends of viewer
store.set('User', 2, 'name', 'Emily');
store.set('User', 3, 'name', 'Caroline');
store.set('User', 1, 'friends', [store.get('User', 2), store.get('User', 3)]);But it also supports nested set:
store.set('Query', 'ROOT', 'viewer', {
name: 'Alexandre',
friends: [
{ name: 'Emily' }
{ name: 'Caroline }
]
});Type Parameters
KeyT
KeyT extends KeyTypeConstraints = string
Parameters
args
SetArgs<KeyT>
Returns
void
Call Signature
set<
KeyT>(typeName,key,fieldName,value?):void
Defined in: packages/mock/src/types.ts:174
Shorthand for set({typeName, key, fieldName, value}).
Type Parameters
KeyT
KeyT extends KeyTypeConstraints = string
Parameters
typeName
string
key
KeyT
fieldName
string
value?
unknown
Returns
void
Call Signature
set<
KeyT>(typeName,key,values):void
Defined in: packages/mock/src/types.ts:184
Set the given field values to the type with key.
Type Parameters
KeyT
KeyT extends KeyTypeConstraints = string
Parameters
typeName
string
key
KeyT
values
Returns
void
Call Signature
set<
KeyT>(ref,fieldName,value?):void
Defined in: packages/mock/src/types.ts:193
Shorthand for set({ref.$ref.typeName, ref.$ref.key, fieldName, value}).
Type Parameters
KeyT
KeyT extends KeyTypeConstraints = string
Parameters
ref
Ref<KeyT>
fieldName
string
value?
unknown
Returns
void
Call Signature
set<
KeyT>(ref,values):void
Defined in: packages/mock/src/types.ts:202
Set the given field values to the type with ref.
Type Parameters
KeyT
KeyT extends KeyTypeConstraints = string
Parameters
ref
Ref<KeyT>
values
Returns
void