Vulcan Documentation
GitHub
Slack
Vulcan Documentation Vulcan Documentation
GitHub
Slack

Cheatsheet

Edit on GitHub

Queries

Input

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
const singleInput = {
  filter,
  sort,
  search,
  id,
  enableCache,
  enableTotal,
  contextName,
}

const multiInput = {
  filter,
  sort,
  search,
  offset,
  limit,
  enableCache,
  enableTotal,
  contextName,
}

Hooks

1
2
3
4
5
6
7
const { document, loading, error, networkStatus, refetch } = useSingle2({ 
  collection, 
  fragmentName, 
  input, 
  pollInterval, 
  queryOptions, // passed to Apollo hook
});
1
2
3
4
5
6
7
const { results, loading, error, networkStatus, refetch } = useMulti2({ 
  collection, 
  fragmentName, 
  input, 
  pollInterval, 
  queryOptions, // passed to Apollo hook
});

Mutations

Hooks

1
2
3
4
5
6
7
8
const [ createFunction, { data, loading, error }] = useCreate2({ 
  collection, 
  fragmentName, 
  mutationOptions, // passed to Apollo hook
});

// to use the function: 
createFunction({ input: { data } });
1
2
3
4
5
6
7
8
const [ updateFunction, { data, loading, error }] = useUpdate2({ 
  collection, 
  fragmentName, 
  mutationOptions, // passed to Apollo hook
});

// to use the function: 
updateFunction({ input: { id, data } });
1
2
3
4
5
6
7
8
const [ deleteFunction, { data, loading, error }] = useDelete2({ 
  collection, 
  fragmentName, 
  mutationOptions, // passed to Apollo hook
});

// to use the function: 
deleteFunction({ input: { id } });

Mutators

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
await createMutator({
  collection, // collection containing document to mutate
  data, // data received from client
  currentUser, // current user
  validate, // boolean, whether to validate the operation
  context, // GraphQL context
});

await updateMutator({
  documentId // id of document to mutate
  collection,
  data,
  currentUser,
  validate,
  context,
});

await deleteMutator({
  documentId,
  collection,
  currentUser,
  validate,
  context,
});

Callbacks

Properties

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
// movies.create.*
const properties = {
  data,
  originalData: clone(data),
  currentUser,
  collection,
  context,
  schema,
};

// movies.update.*
const properties = {
  data,
  originalData: clone(data),
  document,
  originalDocument: oldDocument,
  currentUser,
  collection,
  context,
  schema,
};

// movies.delete.*
const properties = { 
  document, 
  currentUser, 
  collection, 
  context, 
  schema 
};

Mutation Callbacks

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
createCollection({
  callbacks {
    create: {
      validate: [(validationErrors, properties) => { return validationErrors; }],
      before: [(document, properties) => { return document; }],
      after: [(document, properties) => { return document; }],
      async: [(properties) => { /* no return value */ }],
    }
    update: {
      validate: [(validationErrors, properties) => { return validationErrors; }],
      before: [(data, properties) => { return data; }],
      after: [(document, properties) => { return document; }],
      async: [(properties) => { /* no return value */ }],
    }
    delete: {
      validate: [(validationErrors, properties) => { return validationErrors; }],
      before: [(document, properties) => { return document; }],
      after: [(document, properties) => { return document; }],
      async: [(properties) => { /* no return value */ }],
    }
  }
});

Field Callbacks

const schema = {
  field: {
    onCreate: (properties) => { return fieldValue },
    onUpdate: (properties) => { return fieldValue },
    onDelete: (properties) => { // return nothing }
  }
}
Edit on GitHub