forked from firecmsco/firecms
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2,658 changed files
with
74,375 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
label: "API" |
69 changes: 69 additions & 0 deletions
69
website/versioned_docs/version-2.0.0/api/classes/EntityReference.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,69 @@ | ||
--- | ||
id: "EntityReference" | ||
title: "Class: EntityReference" | ||
sidebar_label: "EntityReference" | ||
sidebar_position: 0 | ||
custom_edit_url: null | ||
--- | ||
|
||
Class used to create a reference to an entity in a different path | ||
|
||
## Constructors | ||
|
||
### constructor | ||
|
||
• **new EntityReference**(`id`, `path`): [`EntityReference`](EntityReference.md) | ||
|
||
#### Parameters | ||
|
||
| Name | Type | | ||
| :------ | :------ | | ||
| `id` | `string` | | ||
| `path` | `string` | | ||
|
||
#### Returns | ||
|
||
[`EntityReference`](EntityReference.md) | ||
|
||
#### Defined in | ||
|
||
[packages/firecms_core/src/types/entities.ts:51](https://github.com/FireCMSco/firecms/blob/d45f3739/packages/firecms_core/src/types/entities.ts#L51) | ||
|
||
## Properties | ||
|
||
### id | ||
|
||
• `Readonly` **id**: `string` | ||
|
||
ID of the entity | ||
|
||
#### Defined in | ||
|
||
[packages/firecms_core/src/types/entities.ts:44](https://github.com/FireCMSco/firecms/blob/d45f3739/packages/firecms_core/src/types/entities.ts#L44) | ||
|
||
___ | ||
|
||
### path | ||
|
||
• `Readonly` **path**: `string` | ||
|
||
A string representing the path of the referenced document (relative | ||
to the root of the database). | ||
|
||
#### Defined in | ||
|
||
[packages/firecms_core/src/types/entities.ts:49](https://github.com/FireCMSco/firecms/blob/d45f3739/packages/firecms_core/src/types/entities.ts#L49) | ||
|
||
## Accessors | ||
|
||
### pathWithId | ||
|
||
• `get` **pathWithId**(): `string` | ||
|
||
#### Returns | ||
|
||
`string` | ||
|
||
#### Defined in | ||
|
||
[packages/firecms_core/src/types/entities.ts:56](https://github.com/FireCMSco/firecms/blob/d45f3739/packages/firecms_core/src/types/entities.ts#L56) |
Oops, something went wrong.