Skip to content

Commit

Permalink
Added V2 API
Browse files Browse the repository at this point in the history
  • Loading branch information
fgatti675 committed Nov 30, 2023
1 parent e04d003 commit 56ab6f1
Show file tree
Hide file tree
Showing 2,658 changed files with 74,375 additions and 0 deletions.
1 change: 1 addition & 0 deletions website/versioned_docs/version-2.0.0/api/_category_.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
label: "API"
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)
Loading

0 comments on commit 56ab6f1

Please sign in to comment.