Skip to content

Commit 4159167

Browse files
committed
feat(typesync pkg): update README
1 parent db012c1 commit 4159167

File tree

1 file changed

+2
-7
lines changed

1 file changed

+2
-7
lines changed

packages/typesync/README.md

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Package for generating the mappings used within the `hypergraph` ecosystem that
44

55
The `Mapping` is passed to the `<HypergraphSpaceProvider>` from the [@graphprotocol/hypergraph-react](../hypergraph-react/README.md) context to inform the query layer what entities to query from the Knowledge Graph.
66

7-
This package exposes a function: `generateMappings` that takes the schema with an array of types, each with properties. Both `types` and `properties` have a nullable `knowledgeGraphId` UUID value. If a value is provided, the `type/property` exists on the Knowledge Graph; this value will be plugged into to the `Mapping` values. If the `knowledgeGraphId` value is null, the `type/property` will be created using the `@graphprotocol/grc-20` ops and then returned in the mapping.
7+
This package exposes a function: `generateMapping` that takes the schema with an array of types, each with properties. Both `types` and `properties` have a nullable `knowledgeGraphId` UUID value. If a value is provided, the `type/property` exists on the Knowledge Graph; this value will be plugged into to the `Mapping` values. If the `knowledgeGraphId` value is null, the `type/property` will be created using the `@graphprotocol/grc-20` ops and then returned in the mapping.
88

99
## Mapping definition
1010

@@ -14,9 +14,6 @@ export type MappingEntry = {
1414
properties?: {
1515
[key: string]: Grc20Id.Id;
1616
};
17-
relations?: {
18-
[key: string]: Grc20Id.Id;
19-
};
2017
};
2118

2219
export type Mapping = {
@@ -62,10 +59,8 @@ export const mapping: Mapping = {
6259
properties: {
6360
name: Id.Id('3808e060-fb4a-4d08-8069-35b8c8a1902b'),
6461
description: Id.Id('1f0d9007-8da2-4b28-ab9f-3bc0709f4837'),
65-
},
66-
relations: {
6762
account: Id.Id('a5fd07b1-120f-46c6-b46f-387ef98396a6')
68-
}
63+
},
6964
}
7065
}
7166
```

0 commit comments

Comments
 (0)