Class SkillModel

StaticdefineSchema

• defineSchema(): {
      ability: StringField<
          { blank: true; initial: undefined; required: boolean },
          AssignmentType<{ blank: true; initial: undefined; required: boolean }>,
          InitializedType<{ blank: true; initial: undefined; required: boolean }>,
          InitializedType<{ blank: true; initial: undefined; required: boolean }>,
      >;
      acp: BooleanField<
          { initial: undefined; required: boolean },
          AssignmentType<
              SimpleMerge<{ initial: undefined; required: boolean }, DefaultOptions>,
          >,
          InitializedType<
              SimpleMerge<{ initial: undefined; required: boolean }, DefaultOptions>,
          >,
          InitializedType<
              SimpleMerge<{ initial: undefined; required: boolean }, DefaultOptions>,
          >,
      >;
      journal: DocumentUUIDField<
          { initial: undefined; required: boolean },
          AssignmentType<{ initial: undefined; required: boolean }>,
          InitializedType<{ initial: undefined; required: boolean }>,
          InitializedType<{ initial: undefined; required: boolean }>,
      >;
      name: StringField<
          { initial: undefined; required: boolean },
          AssignmentType<{ initial: undefined; required: boolean }>,
          InitializedType<{ initial: undefined; required: boolean }>,
          InitializedType<{ initial: undefined; required: boolean }>,
      >;
      rank: NumberField<
          { initial: 0; integer: true; min: 0; required: false },
          AssignmentType<{ initial: 0; integer: true; min: 0; required: false }>,
          InitializedType<{ initial: 0; integer: true; min: 0; required: false }>,
          InitializedType<{ initial: 0; integer: true; min: 0; required: false }>,
      >;
      rt: BooleanField<
          { initial: undefined; required: boolean },
          AssignmentType<
              SimpleMerge<{ initial: undefined; required: boolean }, DefaultOptions>,
          >,
          InitializedType<
              SimpleMerge<{ initial: undefined; required: boolean }, DefaultOptions>,
          >,
          InitializedType<
              SimpleMerge<{ initial: undefined; required: boolean }, DefaultOptions>,
          >,
      >;
      subSkills: TypedObjectField<
          EmbeddedDataField<
              typeof SkillData,
              DefaultOptions,
              AssignmentType<typeof SkillData, DefaultOptions>,
              SkillData,
              {
                  ability: InitializedType<
                      { blank: true; initial: undefined; required: boolean },
                  >;
                  acp: InitializedType<
                      SimpleMerge<
                          { initial: undefined; required: boolean },
                          DefaultOptions,
                      >,
                  >;
                  journal: InitializedType<{ initial: undefined; required: boolean }>;
                  name: InitializedType<{ initial: undefined; required: boolean }>;
                  rank: InitializedType<
                      { initial: 0; integer: true; min: 0; required: false },
                  >;
                  rt: InitializedType<
                      SimpleMerge<
                          { initial: undefined; required: boolean },
                          DefaultOptions,
                      >,
                  >;
              },
          >,
          DefaultOptions,
          AssignmentType<
              EmbeddedDataField<
                  typeof SkillData,
                  DefaultOptions,
                  AssignmentType<typeof SkillData, DefaultOptions>,
                  SkillData,
                  {
                      ability: InitializedType<
                          { blank: true; initial: undefined; required: boolean },
                      >;
                      acp: InitializedType<
                          SimpleMerge<
                              { initial: undefined; required: boolean },
                              DefaultOptions,
                          >,
                      >;
                      journal: InitializedType<{ initial: undefined; required: boolean }>;
                      name: InitializedType<{ initial: undefined; required: boolean }>;
                      rank: InitializedType<
                          { initial: 0; integer: true; min: 0; required: false },
                      >;
                      rt: InitializedType<
                          SimpleMerge<
                              { initial: undefined; required: boolean },
                              DefaultOptions,
                          >,
                      >;
                  },
              >,
              DefaultOptions,
          >,
          { [key: string]: SkillData },
          { [key: string]: SkillData },
      >;
  }

  Define the data schema for documents of this type. The schema is populated the first time it is accessed and cached for future reuse.

  Returns {
      ability: StringField<
          { blank: true; initial: undefined; required: boolean },
          AssignmentType<{ blank: true; initial: undefined; required: boolean }>,
          InitializedType<{ blank: true; initial: undefined; required: boolean }>,
          InitializedType<{ blank: true; initial: undefined; required: boolean }>,
      >;
      acp: BooleanField<
          { initial: undefined; required: boolean },
          AssignmentType<
              SimpleMerge<{ initial: undefined; required: boolean }, DefaultOptions>,
          >,
          InitializedType<
              SimpleMerge<{ initial: undefined; required: boolean }, DefaultOptions>,
          >,
          InitializedType<
              SimpleMerge<{ initial: undefined; required: boolean }, DefaultOptions>,
          >,
      >;
      journal: DocumentUUIDField<
          { initial: undefined; required: boolean },
          AssignmentType<{ initial: undefined; required: boolean }>,
          InitializedType<{ initial: undefined; required: boolean }>,
          InitializedType<{ initial: undefined; required: boolean }>,
      >;
      name: StringField<
          { initial: undefined; required: boolean },
          AssignmentType<{ initial: undefined; required: boolean }>,
          InitializedType<{ initial: undefined; required: boolean }>,
          InitializedType<{ initial: undefined; required: boolean }>,
      >;
      rank: NumberField<
          { initial: 0; integer: true; min: 0; required: false },
          AssignmentType<{ initial: 0; integer: true; min: 0; required: false }>,
          InitializedType<{ initial: 0; integer: true; min: 0; required: false }>,
          InitializedType<{ initial: 0; integer: true; min: 0; required: false }>,
      >;
      rt: BooleanField<
          { initial: undefined; required: boolean },
          AssignmentType<
              SimpleMerge<{ initial: undefined; required: boolean }, DefaultOptions>,
          >,
          InitializedType<
              SimpleMerge<{ initial: undefined; required: boolean }, DefaultOptions>,
          >,
          InitializedType<
              SimpleMerge<{ initial: undefined; required: boolean }, DefaultOptions>,
          >,
      >;
      subSkills: TypedObjectField<
          EmbeddedDataField<
              typeof SkillData,
              DefaultOptions,
              AssignmentType<typeof SkillData, DefaultOptions>,
              SkillData,
              {
                  ability: InitializedType<
                      { blank: true; initial: undefined; required: boolean },
                  >;
                  acp: InitializedType<
                      SimpleMerge<
                          { initial: undefined; required: boolean },
                          DefaultOptions,
                      >,
                  >;
                  journal: InitializedType<{ initial: undefined; required: boolean }>;
                  name: InitializedType<{ initial: undefined; required: boolean }>;
                  rank: InitializedType<
                      { initial: 0; integer: true; min: 0; required: false },
                  >;
                  rt: InitializedType<
                      SimpleMerge<
                          { initial: undefined; required: boolean },
                          DefaultOptions,
                      >,
                  >;
              },
          >,
          DefaultOptions,
          AssignmentType<
              EmbeddedDataField<
                  typeof SkillData,
                  DefaultOptions,
                  AssignmentType<typeof SkillData, DefaultOptions>,
                  SkillData,
                  {
                      ability: InitializedType<
                          { blank: true; initial: undefined; required: boolean },
                      >;
                      acp: InitializedType<
                          SimpleMerge<
                              { initial: undefined; required: boolean },
                              DefaultOptions,
                          >,
                      >;
                      journal: InitializedType<{ initial: undefined; required: boolean }>;
                      name: InitializedType<{ initial: undefined; required: boolean }>;
                      rank: InitializedType<
                          { initial: 0; integer: true; min: 0; required: false },
                      >;
                      rt: InitializedType<
                          SimpleMerge<
                              { initial: undefined; required: boolean },
                              DefaultOptions,
                          >,
                      >;
                  },
              >,
              DefaultOptions,
          >,
          { [key: string]: SkillData },
          { [key: string]: SkillData },
      >;
  }

  Remarks

  The returned value MUST be kept up to sync with the Schema type parameter.