Padloc Logo Docs & Resources

Class: SRPSession

srp.SRPSession

Hierarchy

Constructors

constructor

new SRPSession()

Inherited from

Serializable.constructor

Properties

A

Optional A: BigInteger

Defined in

core/src/srp.ts:149


B

Optional B: BigInteger

Defined in

core/src/srp.ts:153


K

Optional K: BigInteger

Defined in

core/src/srp.ts:155


M1

Optional M1: BigInteger

Defined in

core/src/srp.ts:157


M2

Optional M2: BigInteger

Defined in

core/src/srp.ts:159


_propertySerializationOptions

_propertySerializationOptions: SerializationOptions[]

Inherited from

Serializable._propertySerializationOptions

Defined in

core/src/encoding.ts:163


a

Optional a: BigInteger

Defined in

core/src/srp.ts:147


b

Optional b: BigInteger

Defined in

core/src/srp.ts:151


created

created: Date

Defined in

core/src/srp.ts:136


id

id: string = ""

Defined in

core/src/srp.ts:133


v

Optional v: BigInteger

Defined in

core/src/srp.ts:145


x

Optional x: BigInteger

Defined in

core/src/srp.ts:143

Accessors

kind

get kind(): string

A string representing the objects "type", useful for segmenting storage, among other things. Defaults to the lowercase class name, but can be overwritten by subclasses

Returns

string

Inherited from

Serializable.kind

Defined in

core/src/encoding.ts:159

Methods

_fromRaw

Protected _fromRaw(raw): void

Restore values from a raw object. The default implementation simply copies over all iterable properties from the base object. Overwrite this method for properties that require special treatment

Parameters

Name Type
raw any

Returns

void

Inherited from

Serializable._fromRaw

Defined in

core/src/encoding.ts:286


_toRaw

Protected _toRaw(version): any

Transform this object into a raw javascript object used for serialization. The default implementation simply copies all iterable properties not included in the [[exlude]] array and calls toRaw on any properties that are themselfes instances of Serializable. This method should be overwritten by subclasses if certain properties require special treatment.

Parameters

Name Type
version undefined | string

Returns

any

Inherited from

Serializable._toRaw

Defined in

core/src/encoding.ts:257


clone

clone(): SRPSession

Creates a deep clone of the object

Returns

SRPSession

Inherited from

Serializable.clone

Defined in

core/src/encoding.ts:244


fromBytes

fromBytes(bytes): SRPSession

Deserializes the object from a byte array

Parameters

Name Type
bytes Uint8Array

Returns

SRPSession

Inherited from

Serializable.fromBytes

Defined in

core/src/encoding.ts:237


fromJSON

fromJSON(json): SRPSession

Deserializes the object from a JSON string

Parameters

Name Type
json string

Returns

SRPSession

Inherited from

Serializable.fromJSON

Defined in

core/src/encoding.ts:223


fromRaw

fromRaw(raw): SRPSession

Restores propertiers from a raw object of the same form generated by toRaw. The base implementation blindly copies over values from the raw object via Object.assign so subclasses should explictly process any propertyies that need special treatment.

Also takes are of validation and "upgrading" in case the raw object has an old version. Use the protected _fromRaw method to implement subclass-specific behavior.

Parameters

Name Type
raw any

Returns

SRPSession

Inherited from

Serializable.fromRaw

Defined in

core/src/encoding.ts:196


init

init(): Promise<void>

Returns

Promise<void>

Defined in

core/src/srp.ts:138


toBytes

toBytes(): Uint8Array

Returns a serialization of the object in form of a byte array

Returns

Uint8Array

Inherited from

Serializable.toBytes

Defined in

core/src/encoding.ts:230


toJSON

toJSON(): string

Returns a JSON serialization of the object

Returns

string

Inherited from

Serializable.toJSON

Defined in

core/src/encoding.ts:216


toRaw

toRaw(version?): any

Creates a raw javascript object representation of the class, which can be used for storage or data transmission. Also handles "downgrading" to previous versions. Use _toRaw for subclass-specific behavior.

Parameters

Name Type
version? string

Returns

any

Inherited from

Serializable.toRaw

Defined in

core/src/encoding.ts:179


validate

validate(): boolean

This is called during deserialization and should verify that all properties have been populated with values of the correct type. Subclasses should implement this method based on their class structure.

Returns

boolean

Inherited from

Serializable.validate

Defined in

core/src/encoding.ts:170