dev.npmx.actor.profile Documentation (EN)

main record

A declaration of an npmx account profile.

Record Key literal:self Fixed literal value

Properties

avatar blob Optional

AKA, 'profile picture'

maxSize: 1.0 MB

description string Optional

Free-form profile description text.

maxLength: 2560 bytesmaxGraphemes: 256 graphemes

displayName string Required

No description available.

maxLength: 640 bytesmaxGraphemes: 64 graphemes

website string uri Optional

A valid URI.

View raw schema

{
  "description": "A declaration of an npmx account profile.",
  "key": "literal:self",
  "record": {
    "properties": {
      "avatar": {
        "accept": [
          "image/png",
          "image/jpeg"
        ],
        "description": "AKA, 'profile picture'",
        "maxSize": 1000000,
        "type": "blob"
      },
      "description": {
        "description": "Free-form profile description text.",
        "maxGraphemes": 256,
        "maxLength": 2560,
        "type": "string"
      },
      "displayName": {
        "maxGraphemes": 64,
        "maxLength": 640,
        "type": "string"
      },
      "website": {
        "format": "uri",
        "type": "string"
      }
    },
    "required": [
      "displayName"
    ],
    "type": "object"
  },
  "type": "record"
}