Skip to content

@graphty/graphty-element / index / Credential

Interface: Credential ​

Defined in: graph-io/dist/src/sources/types.d.ts:53

A credential made by one of the credentials factories. The secret is held where no code can read it back: JSON.stringify and util.inspect show only { kind, origins }. Experimental.

Properties ​

kind ​

readonly kind: CredentialKind

Defined in: graph-io/dist/src/sources/types.d.ts:55

What kind of credential it is.


origins ​

readonly origins: readonly string[]

Defined in: graph-io/dist/src/sources/types.d.ts:60

The origins it may be sent to. Empty means "the load's endpoint origin", decided when it is used.


username? ​

readonly optional username?: string

Defined in: graph-io/dist/src/sources/types.d.ts:62

The user name of a basic credential, which is not a secret; undefined for other kinds.