Class WikibaseSenseSnak

Class for the WikibaseSenseSnak.

An example of a property of this type is P5972 (translation).

Hierarchy (View Summary)

Snak
- WikibaseSenseSnak

Index

Constructors

Properties

datatype hash property snaktype

Accessors

hasValue id internalID lexemeId senseId

Methods

equals toJSON fromData

Constructors

constructor

new WikibaseSenseSnak(snak: WikibaseSenseSnak): WikibaseSenseSnak
Parameters
- snak: WikibaseSenseSnak
  The snak for this class in JSON format.
Returns WikibaseSenseSnak
Example
```
const snak = new WikibaseSenseSnak(json);
```
Overrides Snak.constructor
- Defined in src/snaks/WikibaseSenseSnak.ts:26

Properties

datatype

datatype: string = 'wikibase-sense'

hash

hash: string | undefined

property

property: `P${number}`

snaktype

snaktype: SnakType

Accessors

hasValue

get hasValue(): boolean
Checks if the snak has a value.

Returns boolean
True if the snak has a value.
Inherited from Snak.hasValue
- Defined in src/Snak.ts:48

id

get id(): string | undefined
The lexeme ID will take the form L{number}-S{number}.

Returns string | undefined
The value of the snak.

Alias
id
- Defined in src/snaks/WikibaseSenseSnak.ts:40
set id(value: string | undefined): void
Parameters
- value: string | undefined
  The value of the snak.
Returns void
Alias
id
- Defined in src/snaks/WikibaseSenseSnak.ts:48

internalID

get internalID(): string
Creates a unique ID for the Snak.

Returns string
The ID.
Inherited from Snak.internalID
- Defined in src/Snak.ts:57

lexemeId

get lexemeId(): number | undefined
Returns number | undefined
The value of the snak.

Alias
lexemeId
- Defined in src/snaks/WikibaseSenseSnak.ts:64
set lexemeId(value: number | undefined): void
Parameters
- value: number | undefined
  The value of the snak.
Returns void
Alias
lexemeId
- Defined in src/snaks/WikibaseSenseSnak.ts:72

senseId

get senseId(): number | undefined
Returns number | undefined
The value of the snak.

Alias
senseId
- Defined in src/snaks/WikibaseSenseSnak.ts:84
set senseId(value: number | undefined): void
Parameters
- value: number | undefined
  The value of the snak.
Returns void
Alias
senseId
- Defined in src/snaks/WikibaseSenseSnak.ts:92

Methods

equals

equals(other: WikibaseSenseSnak): boolean
This function checks if two snaks are equal.
Parameters
- other: WikibaseSenseSnak
  The other snak.
Returns boolean
True if the snaks are equal.
Example
```
if (snak.equals(other)) {
    // do something
  }
```
Overrides Snak.equals
- Defined in src/snaks/WikibaseSenseSnak.ts:132

toJSON

toJSON(): WikibaseSenseSnak
Returns WikibaseSenseSnak
The snak as JSON.
Example
```
const json = WikibaseSenseSnak.toJson();
```
Overrides Snak.toJSON
- Defined in src/snaks/WikibaseSenseSnak.ts:106

`Static`fromData

fromData(property: `P${number}`, id: `L${number}-S${number}`): WikibaseSenseSnak
Create a new instance of the class from some basic data.
Parameters
- property: `P${number}`
  The property of the snak in 'P-form'.
- id: `L${number}-S${number}`
  The sense ID in 'L{number}-S{number}' form.
Returns WikibaseSenseSnak
A new instance of the class.
Example
```
const snak = WikibaseSenseSnak.fromData('P5972', 'L123-S4');
```
- Defined in src/snaks/WikibaseSenseSnak.ts:147