Class: InvalidIdentifierResource
A resource that represents a URI that does not have a valid URI given the plugins available to the ConnectedLdoDataset.
Hierarchy
TypedEventEmitter\<{notification: () =>void;update: () =>void},this>
↳ InvalidIdentifierResource
Implements
Constructors
constructor
• new InvalidIdentifierResource(uri): InvalidIdentifierResource
Parameters
| Name | Type |
|---|---|
uri |
string |
Returns
Overrides
(EventEmitter as new () =\> ResourceEventEmitter).constructor
Defined in
packages/connected/src/InvalidIdentifierResource.ts:18
Properties
isError
• Readonly isError: false
Indicates that this is not an error
Implementation of
Defined in
packages/connected/src/InvalidIdentifierResource.ts:16
status
• status: InvalidUriError\<InvalidIdentifierResource>
The most recent result from one of the resource methods.
Implementation of
Defined in
packages/connected/src/InvalidIdentifierResource.ts:15
type
• Readonly type: "InvalidIdentifierResouce"
The name of the resource. For example "NextGraphResource"
Implementation of
Defined in
packages/connected/src/InvalidIdentifierResource.ts:14
uri
• Readonly uri: string
The uri of the resource
Implementation of
Defined in
packages/connected/src/InvalidIdentifierResource.ts:13
Methods
addListener
▸ addListener\<E>(event, listener): this
Type parameters
| Name | Type |
|---|---|
E |
extends "update" | "notification" |
Parameters
| Name | Type |
|---|---|
event |
E |
listener |
{ notification: () => void ; update: () => void }[E] |
Returns
this
Implementation of
Inherited from
(EventEmitter as new () => ResourceEventEmitter).addListener
Defined in
node_modules/typed-emitter/index.d.ts:22
emit
▸ emit\<E>(event, ...args): boolean
Type parameters
| Name | Type |
|---|---|
E |
extends "update" | "notification" |
Parameters
| Name | Type |
|---|---|
event |
E |
...args |
Parameters\<{ notification: () => void ; update: () => void }[E]> |
Returns
boolean
Implementation of
Inherited from
(EventEmitter as new () => ResourceEventEmitter).emit
Defined in
node_modules/typed-emitter/index.d.ts:32
eventNames
▸ eventNames(): (string | symbol)[]
Returns
(string | symbol)[]
Implementation of
Inherited from
(EventEmitter as new () => ResourceEventEmitter).eventNames
Defined in
node_modules/typed-emitter/index.d.ts:34
getMaxListeners
▸ getMaxListeners(): number
Returns
number
Implementation of
Inherited from
(EventEmitter as new () => ResourceEventEmitter).getMaxListeners
Defined in
node_modules/typed-emitter/index.d.ts:39
isAbsent
▸ isAbsent(): boolean
Returns true if its confirmed that this resource doesn't exist. Returns undefined if that is currently unknown.
Returns
boolean
Implementation of
Defined in
packages/connected/src/InvalidIdentifierResource.ts:39
isDoingInitialFetch
▸ isDoingInitialFetch(): boolean
Returns true if this resource is currently performing its first fetch
Returns
boolean
Implementation of
Defined in
packages/connected/src/InvalidIdentifierResource.ts:33
isFetched
▸ isFetched(): boolean
Returns true if this resource has performed a fetch at least once
Returns
boolean
Implementation of
Defined in
packages/connected/src/InvalidIdentifierResource.ts:27
isLoading
▸ isLoading(): boolean
Returns true if this resource is currently loading.
Returns
boolean
Implementation of
Defined in
packages/connected/src/InvalidIdentifierResource.ts:24
isPresent
▸ isPresent(): boolean
Returns true if this resource exists. Returns undefined if that is currently unknown.
Returns
boolean
Implementation of
Defined in
packages/connected/src/InvalidIdentifierResource.ts:36
isSubscribedToNotifications
▸ isSubscribedToNotifications(): boolean
Returns true if this resource is currently subscribed to notifications.
Returns
boolean
Implementation of
Resource.isSubscribedToNotifications
Defined in
packages/connected/src/InvalidIdentifierResource.ts:42
isUnfetched
▸ isUnfetched(): boolean
Returns true if this reosource has not performed a fetch at least once
Returns
boolean
Implementation of
Defined in
packages/connected/src/InvalidIdentifierResource.ts:30
listenerCount
▸ listenerCount\<E>(event): number
Type parameters
| Name | Type |
|---|---|
E |
extends "update" | "notification" |
Parameters
| Name | Type |
|---|---|
event |
E |
Returns
number
Implementation of
Inherited from
(EventEmitter as new () => ResourceEventEmitter).listenerCount
Defined in
node_modules/typed-emitter/index.d.ts:37
listeners
▸ listeners\<E>(event): { notification: () => void ; update: () => void }[E][]
Type parameters
| Name | Type |
|---|---|
E |
extends "update" | "notification" |
Parameters
| Name | Type |
|---|---|
event |
E |
Returns
{ notification: () => void ; update: () => void }[E][]
Implementation of
Inherited from
(EventEmitter as new () => ResourceEventEmitter).listeners
Defined in
node_modules/typed-emitter/index.d.ts:36
off
▸ off\<E>(event, listener): this
Type parameters
| Name | Type |
|---|---|
E |
extends "update" | "notification" |
Parameters
| Name | Type |
|---|---|
event |
E |
listener |
{ notification: () => void ; update: () => void }[E] |
Returns
this
Implementation of
Inherited from
(EventEmitter as new () => ResourceEventEmitter).off
Defined in
node_modules/typed-emitter/index.d.ts:28
on
▸ on\<E>(event, listener): this
Type parameters
| Name | Type |
|---|---|
E |
extends "update" | "notification" |
Parameters
| Name | Type |
|---|---|
event |
E |
listener |
{ notification: () => void ; update: () => void }[E] |
Returns
this
Implementation of
Inherited from
(EventEmitter as new () => ResourceEventEmitter).on
Defined in
node_modules/typed-emitter/index.d.ts:23
once
▸ once\<E>(event, listener): this
Type parameters
| Name | Type |
|---|---|
E |
extends "update" | "notification" |
Parameters
| Name | Type |
|---|---|
event |
E |
listener |
{ notification: () => void ; update: () => void }[E] |
Returns
this
Implementation of
Inherited from
(EventEmitter as new () => ResourceEventEmitter).once
Defined in
node_modules/typed-emitter/index.d.ts:24
prependListener
▸ prependListener\<E>(event, listener): this
Type parameters
| Name | Type |
|---|---|
E |
extends "update" | "notification" |
Parameters
| Name | Type |
|---|---|
event |
E |
listener |
{ notification: () => void ; update: () => void }[E] |
Returns
this
Implementation of
Inherited from
(EventEmitter as new () => ResourceEventEmitter).prependListener
Defined in
node_modules/typed-emitter/index.d.ts:25
prependOnceListener
▸ prependOnceListener\<E>(event, listener): this
Type parameters
| Name | Type |
|---|---|
E |
extends "update" | "notification" |
Parameters
| Name | Type |
|---|---|
event |
E |
listener |
{ notification: () => void ; update: () => void }[E] |
Returns
this
Implementation of
Inherited from
(EventEmitter as new () => ResourceEventEmitter).prependOnceListener
Defined in
node_modules/typed-emitter/index.d.ts:26
rawListeners
▸ rawListeners\<E>(event): { notification: () => void ; update: () => void }[E][]
Type parameters
| Name | Type |
|---|---|
E |
extends "update" | "notification" |
Parameters
| Name | Type |
|---|---|
event |
E |
Returns
{ notification: () => void ; update: () => void }[E][]
Implementation of
Inherited from
(EventEmitter as new () => ResourceEventEmitter).rawListeners
Defined in
node_modules/typed-emitter/index.d.ts:35
read
▸ read(): Promise\<InvalidUriError\<InvalidIdentifierResource>>
Fetches the resource.
Returns
Promise\<InvalidUriError\<InvalidIdentifierResource>>
Implementation of
Defined in
packages/connected/src/InvalidIdentifierResource.ts:45
readIfUnfetched
▸ readIfUnfetched(): Promise\<InvalidUriError\<InvalidIdentifierResource>>
Fetches the resource if it hasn't been fetched yet.
Returns
Promise\<InvalidUriError\<InvalidIdentifierResource>>
Implementation of
Defined in
packages/connected/src/InvalidIdentifierResource.ts:48
removeAllListeners
▸ removeAllListeners\<E>(event?): this
Type parameters
| Name | Type |
|---|---|
E |
extends "update" | "notification" |
Parameters
| Name | Type |
|---|---|
event? |
E |
Returns
this
Implementation of
Inherited from
(EventEmitter as new () => ResourceEventEmitter).removeAllListeners
Defined in
node_modules/typed-emitter/index.d.ts:29
removeListener
▸ removeListener\<E>(event, listener): this
Type parameters
| Name | Type |
|---|---|
E |
extends "update" | "notification" |
Parameters
| Name | Type |
|---|---|
event |
E |
listener |
{ notification: () => void ; update: () => void }[E] |
Returns
this
Implementation of
Inherited from
(EventEmitter as new () => ResourceEventEmitter).removeListener
Defined in
node_modules/typed-emitter/index.d.ts:30
setMaxListeners
▸ setMaxListeners(maxListeners): this
Parameters
| Name | Type |
|---|---|
maxListeners |
number |
Returns
this
Implementation of
Inherited from
(EventEmitter as new () => ResourceEventEmitter).setMaxListeners
Defined in
node_modules/typed-emitter/index.d.ts:40
subscribeToNotifications
▸ subscribeToNotifications(_callbacks?): Promise\<string>
Begins a subscription to this resource
Parameters
| Name | Type | Description |
|---|---|---|
_callbacks? |
Object |
optional set of callbacks to be called when this resource is updated |
_callbacks.onNotification |
(message: unknown) => void |
- |
_callbacks.onNotificationError |
(err: Error) => void |
- |
Returns
Promise\<string>
Implementation of
Resource.subscribeToNotifications
Defined in
packages/connected/src/InvalidIdentifierResource.ts:54
unsubscribeFromAllNotifications
▸ unsubscribeFromAllNotifications(): Promise\<void>
Unsubscribes from all notifications.
Returns
Promise\<void>
Implementation of
Resource.unsubscribeFromAllNotifications
Defined in
packages/connected/src/InvalidIdentifierResource.ts:63
unsubscribeFromNotifications
▸ unsubscribeFromNotifications(_subscriptionId): Promise\<void>
Unsubscribes from notifications on this resource
Parameters
| Name | Type | Description |
|---|---|---|
_subscriptionId |
string |
the Id of the subscription to unsubscribe |
Returns
Promise\<void>
Implementation of
Resource.unsubscribeFromNotifications
Defined in
packages/connected/src/InvalidIdentifierResource.ts:60
update
▸ update(): Promise\<InvalidUriError\<InvalidIdentifierResource>>
Applies updates to this resource.
Returns
Promise\<InvalidUriError\<InvalidIdentifierResource>>