DocumentIdentifier (Xantham)

DocumentIdentifier Type

Namespace: Xantham.TypeScript.Wire
Assembly: Xantham.TypeScript.Wire.dll
Parent Module: Proto
Base Type: obj
All Interfaces: IEquatable<DocumentIdentifier> , IStructuralEquatable , IComparable<DocumentIdentifier> , IComparable , IStructuralComparable

The schema types this as `string | { uri: string }` - either a path or a document URI - so it is a union here rather than a record with two optional halves. It needs `DocumentIdentifierConverter` to serialise, which `ProtoJson.options` registers; the converter cannot be attached here as an attribute because it is declared against this type and would close the dependency loop.

Union cases

Union case	Description
`FileName fileName` Full Usage: `FileName fileName` Parameters: fileName : `string`	A file path, written as a bare JSON string. fileName : `string`
`Uri uri` Full Usage: `Uri uri` Parameters: uri : `string`	A document URI, written as `{ "uri": ... }`. uri : `string`

Instance members

Instance member	Description
`this.IsFileName` Full Usage: `this.IsFileName` Returns: `bool`	Returns: `bool`
`this.IsUri` Full Usage: `this.IsUri` Returns: `bool`	Returns: `bool`