Improve type definition for the User class (#1857)

This commit is contained in:
Kevin Kredit 2025-05-28 14:55:16 -04:00 committed by GitHub
parent 88cd1810a3
commit 38c56f84c2
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

28
openpgp.d.ts vendored
View File

@ -120,12 +120,28 @@ export class Subkey {
public revoke(primaryKey: SecretKeyPacket, reasonForRevocation?: ReasonForRevocation, date?: Date, config?: Config): Promise<Subkey>; public revoke(primaryKey: SecretKeyPacket, reasonForRevocation?: ReasonForRevocation, date?: Date, config?: Config): Promise<Subkey>;
} }
export interface User { export class User {
userID: UserIDPacket | null; constructor(userPacket: UserIDPacket | UserAttributePacket, mainKey: Key);
userAttribute: UserAttributePacket | null; public readonly userID: UserIDPacket | null;
selfCertifications: SignaturePacket[]; public readonly userAttribute: UserAttributePacket | null;
otherCertifications: SignaturePacket[]; public selfCertifications: SignaturePacket[];
revocationSignatures: SignaturePacket[]; public otherCertifications: SignaturePacket[];
public revocationSignatures: SignaturePacket[];
public readonly mainKey: Key;
public toPacketList(): PacketList<AnyPacket>;
public clone(): User;
public certify(signingKeys: PrivateKey[], date?: Date, config?: Config): Promise<User>;
public isRevoked(
certificate: SignaturePacket,
keyPacket?: PublicSubkeyPacket | SecretSubkeyPacket | PublicKeyPacket | SecretKeyPacket,
date?: Date,
config?: Config,
): Promise<boolean>;
public verifyCertificate(certificate: SignaturePacket, verificationKeys: PublicKey[], date?: Date, config?: Config): Promise<true | null>;
public verifyAllCertifications(verificationKeys: PublicKey[], date?: Date, config?: Config): Promise<{ keyID: KeyID; valid: boolean | null }[]>;
public verify(date?: Date, config?: Config): Promise<true>;
public update(sourceUser: User, date?: Date, config?: Config): Promise<void>;
public revoke(primaryKey: SecretKeyPacket, reasonForRevocation?: ReasonForRevocation, date?: Date, config?: Config): Promise<User>;
} }
export interface PrimaryUser { export interface PrimaryUser {